libs/geometry/doc/doxy/doxygen_output/xml/group__is__valid.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="group__is__valid" kind="group">
   4     <compoundname>is_valid</compoundname>
   5     <title>is_valid: detect if a geometry is valid</title>
   6       <sectiondef kind="func">
   7       <memberdef kind="function" id="group__is__valid_1ga356cf864eac8d92b2b841419c945b03f" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
   8         <templateparamlist>
   9           <param>
  10             <type>typename Geometry</type>
  11           </param>
  12         </templateparamlist>
  13         <type>bool</type>
  14         <definition>bool boost::geometry::is_valid</definition>
  15         <argsstring>(Geometry const &amp;geometry)</argsstring>
  16         <name>is_valid</name>
  17         <param>
  18           <type>Geometry const &amp;</type>
  19           <declname>geometry</declname>
  20         </param>
  21         <briefdescription>
  22 <para>Checks if a geometry is valid (in the OGC sense) </para>        </briefdescription>
  23         <detaileddescription>
  24 <para><parameterlist kind="templateparam"><parameteritem>
  25 <parameternamelist>
  26 <parametername>Geometry</parametername>
  27 </parameternamelist>
  28 <parameterdescription>
  29 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  30 </parameteritem>
  31 </parameterlist>
  32 <parameterlist kind="param"><parameteritem>
  33 <parameternamelist>
  34 <parametername>geometry</parametername>
  35 </parameternamelist>
  36 <parameterdescription>
  37 <para>A model of the specified concept </para></parameterdescription>
  38 </parameteritem>
  39 </parameterlist>
  40 <simplesect kind="return"><para>Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points</para></simplesect>
  41  <qbk>[include reference/algorithms/is_valid.qbk]</qbk>  </para>        </detaileddescription>
  42         <inbodydescription>
  43         </inbodydescription>
  44         <location file="/home/ubuntu/boost/boost/geometry/algorithms/detail/is_valid/interface.hpp" line="97" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/detail/is_valid/interface.hpp" bodystart="97" bodyend="101"/>
  45       </memberdef>
  46       <memberdef kind="function" id="group__is__valid_1ga679fa00f8e9cc0a124fcdba608516dfc" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  47         <templateparamlist>
  48           <param>
  49             <type>typename Geometry</type>
  50           </param>
  51         </templateparamlist>
  52         <type>bool</type>
  53         <definition>bool boost::geometry::is_valid</definition>
  54         <argsstring>(Geometry const &amp;geometry, validity_failure_type &amp;failure)</argsstring>
  55         <name>is_valid</name>
  56         <param>
  57           <type>Geometry const &amp;</type>
  58           <declname>geometry</declname>
  59         </param>
  60         <param>
  61           <type>validity_failure_type &amp;</type>
  62           <declname>failure</declname>
  63         </param>
  64         <briefdescription>
  65 <para>Checks if a geometry is valid (in the OGC sense) </para>        </briefdescription>
  66         <detaileddescription>
  67 <para><parameterlist kind="templateparam"><parameteritem>
  68 <parameternamelist>
  69 <parametername>Geometry</parametername>
  70 </parameternamelist>
  71 <parameterdescription>
  72 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
  73 </parameteritem>
  74 </parameterlist>
  75 <parameterlist kind="param"><parameteritem>
  76 <parameternamelist>
  77 <parametername>geometry</parametername>
  78 </parameternamelist>
  79 <parameterdescription>
  80 <para>A model of the specified concept </para></parameterdescription>
  81 </parameteritem>
  82 <parameteritem>
  83 <parameternamelist>
  84 <parametername>failure</parametername>
  85 </parameternamelist>
  86 <parameterdescription>
  87 <para>An enumeration value indicating that the geometry is valid or not, and if not valid indicating the reason why </para></parameterdescription>
  88 </parameteritem>
  89 </parameterlist>
  90 <simplesect kind="return"><para>Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points</para></simplesect>
  91  <qbk.distinguish>with failure value</qbk.distinguish>   <qbk>[include reference/algorithms/is_valid_with_failure.qbk]</qbk>  </para>        </detaileddescription>
  92         <inbodydescription>
  93         </inbodydescription>
  94         <location file="/home/ubuntu/boost/boost/geometry/algorithms/detail/is_valid/interface.hpp" line="121" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/detail/is_valid/interface.hpp" bodystart="121" bodyend="127"/>
  95       </memberdef>
  96       <memberdef kind="function" id="group__is__valid_1gaf0867398eaeea60e5c004a8615c7c28c" prot="public" static="no" const="no" explicit="no" inline="yes" virt="non-virtual">
  97         <templateparamlist>
  98           <param>
  99             <type>typename Geometry</type>
 100           </param>
 101         </templateparamlist>
 102         <type>bool</type>
 103         <definition>bool boost::geometry::is_valid</definition>
 104         <argsstring>(Geometry const &amp;geometry, std::string &amp;message)</argsstring>
 105         <name>is_valid</name>
 106         <param>
 107           <type>Geometry const &amp;</type>
 108           <declname>geometry</declname>
 109         </param>
 110         <param>
 111           <type>std::string &amp;</type>
 112           <declname>message</declname>
 113         </param>
 114         <briefdescription>
 115 <para>Checks if a geometry is valid (in the OGC sense) </para>        </briefdescription>
 116         <detaileddescription>
 117 <para><parameterlist kind="templateparam"><parameteritem>
 118 <parameternamelist>
 119 <parametername>Geometry</parametername>
 120 </parameternamelist>
 121 <parameterdescription>
 122 <para>Any type fulfilling a Geometry Concept </para></parameterdescription>
 123 </parameteritem>
 124 </parameterlist>
 125 <parameterlist kind="param"><parameteritem>
 126 <parameternamelist>
 127 <parametername>geometry</parametername>
 128 </parameternamelist>
 129 <parameterdescription>
 130 <para>A model of the specified concept </para></parameterdescription>
 131 </parameteritem>
 132 <parameteritem>
 133 <parameternamelist>
 134 <parametername>message</parametername>
 135 </parameternamelist>
 136 <parameterdescription>
 137 <para>A string containing a message stating if the geometry is valid or not, and if not valid a reason why </para></parameterdescription>
 138 </parameteritem>
 139 </parameterlist>
 140 <simplesect kind="return"><para>Returns true if the geometry is valid (in the OGC sense); furthermore, the following geometries are considered valid: multi-geometries with no elements, linear geometries containing spikes, areal geometries with duplicate (consecutive) points</para></simplesect>
 141  <qbk.distinguish>with message</qbk.distinguish>   <qbk>[include reference/algorithms/is_valid_with_message.qbk]</qbk>  </para>        </detaileddescription>
 142         <inbodydescription>
 143         </inbodydescription>
 144         <location file="/home/ubuntu/boost/boost/geometry/algorithms/detail/is_valid/interface.hpp" line="147" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/detail/is_valid/interface.hpp" bodystart="147" bodyend="154"/>
 145       </memberdef>
 146       </sectiondef>
 147     <briefdescription>
 148     </briefdescription>
 149     <detaileddescription>
 150     </detaileddescription>
 151   </compounddef>
 152 </doxygen>