libs/geometry/doc/doxy/doxygen_output/xml/classboost_1_1geometry_1_1centroid__exception.xml

   1 <?xml version='1.0' encoding='UTF-8' standalone='no'?>
   2 <doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="1.8.6">
   3   <compounddef id="classboost_1_1geometry_1_1centroid__exception" kind="class" prot="public">
   4     <compoundname>boost::geometry::centroid_exception</compoundname>
   5     <basecompoundref refid="classboost_1_1geometry_1_1exception" prot="public" virt="non-virtual">boost::geometry::exception</basecompoundref>
   6     <includes local="no">centroid.hpp</includes>
   7       <sectiondef kind="public-func">
   8       <memberdef kind="function" id="classboost_1_1geometry_1_1centroid__exception_1aa7f89d82571adc93bd774789cb3bfacf" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   9         <type></type>
  10         <definition>boost::geometry::centroid_exception::centroid_exception</definition>
  11         <argsstring>()</argsstring>
  12         <name>centroid_exception</name>
  13         <briefdescription>
  14 <para>The default constructor. </para>        </briefdescription>
  15         <detaileddescription>
  16         </detaileddescription>
  17         <inbodydescription>
  18         </inbodydescription>
  19         <location file="/home/ubuntu/boost/boost/geometry/algorithms/centroid.hpp" line="89" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/centroid.hpp" bodystart="89" bodyend="89"/>
  20       </memberdef>
  21       <memberdef kind="function" id="classboost_1_1geometry_1_1centroid__exception_1a53fc09976554829bab5269f436d60d10" prot="public" static="no" const="yes" explicit="no" inline="yes" virt="virtual">
  22         <type>char const *</type>
  23         <definition>virtual char const* boost::geometry::centroid_exception::what</definition>
  24         <argsstring>() const </argsstring>
  25         <name>what</name>
  26         <reimplements refid="classboost_1_1geometry_1_1exception_1ad9081ff7bda60a00da3de2ae4ff4ba7d">what</reimplements>
  27         <exceptions> throw ()</exceptions>
  28         <briefdescription>
  29 <para>Returns the explanatory string. </para>        </briefdescription>
  30         <detaileddescription>
  31 <para><simplesect kind="return"><para>Pointer to a null-terminated string with explanatory information. </para></simplesect>
  32 </para>        </detaileddescription>
  33         <inbodydescription>
  34         </inbodydescription>
  35         <location file="/home/ubuntu/boost/boost/geometry/algorithms/centroid.hpp" line="95" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/centroid.hpp" bodystart="95" bodyend="98"/>
  36       </memberdef>
  37       </sectiondef>
  38     <briefdescription>
  39 <para>Centroid Exception. </para>    </briefdescription>
  40     <detaileddescription>
  41 <para>The <ref refid="classboost_1_1geometry_1_1centroid__exception" kindref="compound">centroid_exception</ref> is thrown if the free centroid function is called with geometries for which the centroid cannot be calculated. For example: a linestring without points, a polygon without points, an empty multi-geometry.  <qbk>
  42 [heading See also]
  43 \* [link geometry.reference.algorithms.centroid the centroid function]
  44 </qbk>  </para>    </detaileddescription>
  45     <inheritancegraph>
  46       <node id="24">
  47         <label>boost::geometry::exception</label>
  48         <link refid="classboost_1_1geometry_1_1exception"/>
  49         <childnode refid="25" relation="public-inheritance">
  50         </childnode>
  51       </node>
  52       <node id="23">
  53         <label>boost::geometry::centroid_exception</label>
  54         <link refid="classboost_1_1geometry_1_1centroid__exception"/>
  55         <childnode refid="24" relation="public-inheritance">
  56         </childnode>
  57       </node>
  58       <node id="25">
  59         <label>std::exception</label>
  60       </node>
  61     </inheritancegraph>
  62     <collaborationgraph>
  63       <node id="27">
  64         <label>boost::geometry::exception</label>
  65         <link refid="classboost_1_1geometry_1_1exception"/>
  66         <childnode refid="28" relation="public-inheritance">
  67         </childnode>
  68       </node>
  69       <node id="26">
  70         <label>boost::geometry::centroid_exception</label>
  71         <link refid="classboost_1_1geometry_1_1centroid__exception"/>
  72         <childnode refid="27" relation="public-inheritance">
  73         </childnode>
  74       </node>
  75       <node id="28">
  76         <label>std::exception</label>
  77       </node>
  78     </collaborationgraph>
  79     <location file="/home/ubuntu/boost/boost/geometry/algorithms/centroid.hpp" line="83" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/centroid.hpp" bodystart="82" bodyend="99"/>
  80     <listofallmembers>
  81       <member refid="classboost_1_1geometry_1_1centroid__exception_1aa7f89d82571adc93bd774789cb3bfacf" prot="public" virt="non-virtual"><scope>boost::geometry::centroid_exception</scope><name>centroid_exception</name></member>
  82       <member refid="classboost_1_1geometry_1_1centroid__exception_1a53fc09976554829bab5269f436d60d10" prot="public" virt="virtual"><scope>boost::geometry::centroid_exception</scope><name>what</name></member>
  83     </listofallmembers>
  84   </compounddef>
  85 </doxygen>