libs/geometry/doc/doxy/doxygen_output/xml/group__enum.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__enum" kind="group">
   4     <compoundname>enum</compoundname>
   5     <title>enum: enumerations</title>
   6       <sectiondef kind="enum">
   7       <memberdef kind="enum" id="group__enum_1gaf73238cbd03ff9961f8547d084d83e2c" prot="public" static="no">
   8         <name>buffer_side_selector</name>
   9         <enumvalue id="group__enum_1ggaf73238cbd03ff9961f8547d084d83e2ca85f7bc4b2bf45e6ce03256a4edac146f" prot="public">
  10           <name>buffer_side_left</name>
  11           <briefdescription>
  12           </briefdescription>
  13           <detaileddescription>
  14           </detaileddescription>
  15         </enumvalue>
  16         <enumvalue id="group__enum_1ggaf73238cbd03ff9961f8547d084d83e2ca51fff9a1fc847ec098c25adfe8ec5b9b" prot="public">
  17           <name>buffer_side_right</name>
  18           <briefdescription>
  19           </briefdescription>
  20           <detaileddescription>
  21           </detaileddescription>
  22         </enumvalue>
  23         <briefdescription>
  24 <para>Enumerates options for side of buffer (left/right w.r.t. directed segment) </para>        </briefdescription>
  25         <detaileddescription>
  26 <para>Around a linestring, a buffer can be defined left or right. Around a polygon, assumed clockwise internally, a buffer is either on the left side (inflates the polygon), or on the right side (deflates the polygon) </para>        </detaileddescription>
  27         <inbodydescription>
  28         </inbodydescription>
  29         <location file="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" line="56" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" bodystart="56" bodyend="56"/>
  30       </memberdef>
  31       <memberdef kind="enum" id="group__enum_1ga7d33eca9a5389952bdf719972eb802b6" prot="public" static="no">
  32         <name>closure_selector</name>
  33         <enumvalue id="group__enum_1gga7d33eca9a5389952bdf719972eb802b6a684591bd018092efa79ef4b7731b7b05" prot="public">
  34           <name>open</name>
  35           <initializer>= 0</initializer>
  36           <briefdescription>
  37           </briefdescription>
  38           <detaileddescription>
  39 <para>Rings are open: first point and last point are different, algorithms close them explicitly on the fly </para>          </detaileddescription>
  40         </enumvalue>
  41         <enumvalue id="group__enum_1gga7d33eca9a5389952bdf719972eb802b6a17768d8af3fcc199a847d70965cbf9c5" prot="public">
  42           <name>closed</name>
  43           <initializer>= 1</initializer>
  44           <briefdescription>
  45 <para>Rings are closed: first point and last point must be the same. </para>          </briefdescription>
  46           <detaileddescription>
  47           </detaileddescription>
  48         </enumvalue>
  49         <enumvalue id="group__enum_1gga7d33eca9a5389952bdf719972eb802b6a6dc65ac8f2b1a2fe71d912b634955510" prot="public">
  50           <name>closure_undertermined</name>
  51           <initializer>= -1</initializer>
  52           <briefdescription>
  53           </briefdescription>
  54           <detaileddescription>
  55 <para>(Not yet implemented): algorithms first figure out if ring must be closed on the fly </para>          </detaileddescription>
  56         </enumvalue>
  57         <briefdescription>
  58 <para>Enumerates options for defining if polygons are open or closed. </para>        </briefdescription>
  59         <detaileddescription>
  60 <para>The enumeration closure_selector describes options for if a polygon is open or closed. In a closed polygon the very first point (per ring) should be equal to the very last point. The specific closing property of a polygon type is defined by the closure metafunction. The closure metafunction defines a value, which is one of the values enumerated in the closure_selector</para><para> <qbk>
  61 [heading See also]
  62 [link geometry.reference.core.closure The closure metafunction]
  63 </qbk>  </para>        </detaileddescription>
  64         <inbodydescription>
  65         </inbodydescription>
  66         <location file="/home/ubuntu/boost/boost/geometry/core/closure.hpp" line="51" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/closure.hpp" bodystart="50" bodyend="60"/>
  67       </memberdef>
  68       <memberdef kind="enum" id="group__enum_1ga2ce054c657ad2094069c44ef0e037b16" prot="public" static="no">
  69         <name>join_selector</name>
  70         <enumvalue id="group__enum_1gga2ce054c657ad2094069c44ef0e037b16a053d8ba146acb5336a8e68ccc4c6eaf1" prot="public">
  71           <name>join_convex</name>
  72           <briefdescription>
  73           </briefdescription>
  74           <detaileddescription>
  75           </detaileddescription>
  76         </enumvalue>
  77         <enumvalue id="group__enum_1gga2ce054c657ad2094069c44ef0e037b16a3413bd3271548163010ad1e936d47fa6" prot="public">
  78           <name>join_concave</name>
  79           <briefdescription>
  80           </briefdescription>
  81           <detaileddescription>
  82           </detaileddescription>
  83         </enumvalue>
  84         <enumvalue id="group__enum_1gga2ce054c657ad2094069c44ef0e037b16a2ba5b4d8a6cfc9ca86c4100b8a37e00b" prot="public">
  85           <name>join_continue</name>
  86           <briefdescription>
  87           </briefdescription>
  88           <detaileddescription>
  89           </detaileddescription>
  90         </enumvalue>
  91         <enumvalue id="group__enum_1gga2ce054c657ad2094069c44ef0e037b16a0979b163712fccfa2811ea6494167265" prot="public">
  92           <name>join_spike</name>
  93           <briefdescription>
  94           </briefdescription>
  95           <detaileddescription>
  96           </detaileddescription>
  97         </enumvalue>
  98         <briefdescription>
  99 <para>Enumerates types of joins. </para>        </briefdescription>
 100         <detaileddescription>
 101         </detaileddescription>
 102         <inbodydescription>
 103         </inbodydescription>
 104         <location file="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" line="79" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" bodystart="78" bodyend="84"/>
 105       </memberdef>
 106       <memberdef kind="enum" id="group__enum_1ga0af1c124acb76f0892024d6d4ab2bc8c" prot="public" static="no">
 107         <name>order_selector</name>
 108         <enumvalue id="group__enum_1gga0af1c124acb76f0892024d6d4ab2bc8ca29458b1c5c6f01e41bc529cff7cdbec2" prot="public">
 109           <name>clockwise</name>
 110           <initializer>= 1</initializer>
 111           <briefdescription>
 112 <para>Points are ordered clockwise. </para>          </briefdescription>
 113           <detaileddescription>
 114           </detaileddescription>
 115         </enumvalue>
 116         <enumvalue id="group__enum_1gga0af1c124acb76f0892024d6d4ab2bc8ca3a0efd1027a55cf48cfc5f9b57391468" prot="public">
 117           <name>counterclockwise</name>
 118           <initializer>= 2</initializer>
 119           <briefdescription>
 120 <para>Points are ordered counter clockwise. </para>          </briefdescription>
 121           <detaileddescription>
 122           </detaileddescription>
 123         </enumvalue>
 124         <enumvalue id="group__enum_1gga0af1c124acb76f0892024d6d4ab2bc8ca0525b242b4e6519d79366300eca9f8da" prot="public">
 125           <name>order_undetermined</name>
 126           <initializer>= 0</initializer>
 127           <briefdescription>
 128           </briefdescription>
 129           <detaileddescription>
 130 <para>Points might be stored in any order, algorithms will determine it on the fly (not yet supported) </para>          </detaileddescription>
 131         </enumvalue>
 132         <briefdescription>
 133 <para>Enumerates options for the order of points within polygons. </para>        </briefdescription>
 134         <detaileddescription>
 135 <para>The enumeration order_selector describes options for the order of points within a polygon. Polygons can be ordered either clockwise or counterclockwise. The specific order of a polygon type is defined by the <ref refid="structboost_1_1geometry_1_1point__order" kindref="compound">point_order</ref> metafunction. The <ref refid="structboost_1_1geometry_1_1point__order" kindref="compound">point_order</ref> metafunction defines a value, which is one of the values enumerated in the order_selector</para><para> <qbk>
 136 [heading See also]
 137 [link geometry.reference.core.point_order The point_order metafunction]
 138 </qbk>  </para>        </detaileddescription>
 139         <inbodydescription>
 140         </inbodydescription>
 141         <location file="/home/ubuntu/boost/boost/geometry/core/point_order.hpp" line="49" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/core/point_order.hpp" bodystart="48" bodyend="57"/>
 142       </memberdef>
 143       <memberdef kind="enum" id="group__enum_1ga79d3ab5282ad51728a40fc5b30fc332d" prot="public" static="no">
 144         <name>piece_type</name>
 145         <enumvalue id="group__enum_1gga79d3ab5282ad51728a40fc5b30fc332da158a3e6a23fcdf6abd8f1858e73514b8" prot="public">
 146           <name>buffered_segment</name>
 147           <briefdescription>
 148           </briefdescription>
 149           <detaileddescription>
 150           </detaileddescription>
 151         </enumvalue>
 152         <enumvalue id="group__enum_1gga79d3ab5282ad51728a40fc5b30fc332da7ee2534a92e01faecec230f188c7af50" prot="public">
 153           <name>buffered_join</name>
 154           <briefdescription>
 155           </briefdescription>
 156           <detaileddescription>
 157           </detaileddescription>
 158         </enumvalue>
 159         <enumvalue id="group__enum_1gga79d3ab5282ad51728a40fc5b30fc332dabb1b35eb299f24000daa33fa2a65b1c9" prot="public">
 160           <name>buffered_round_end</name>
 161           <briefdescription>
 162           </briefdescription>
 163           <detaileddescription>
 164           </detaileddescription>
 165         </enumvalue>
 166         <enumvalue id="group__enum_1gga79d3ab5282ad51728a40fc5b30fc332dac24a175cf38ec6afcf0a95e4704af854" prot="public">
 167           <name>buffered_flat_end</name>
 168           <briefdescription>
 169           </briefdescription>
 170           <detaileddescription>
 171           </detaileddescription>
 172         </enumvalue>
 173         <enumvalue id="group__enum_1gga79d3ab5282ad51728a40fc5b30fc332da0cd980f9eae221f3b9af241f68602c3f" prot="public">
 174           <name>buffered_point</name>
 175           <briefdescription>
 176           </briefdescription>
 177           <detaileddescription>
 178           </detaileddescription>
 179         </enumvalue>
 180         <enumvalue id="group__enum_1gga79d3ab5282ad51728a40fc5b30fc332da792658183c13c2ba99acc9b61ddc2b92" prot="public">
 181           <name>buffered_concave</name>
 182           <briefdescription>
 183           </briefdescription>
 184           <detaileddescription>
 185           </detaileddescription>
 186         </enumvalue>
 187         <enumvalue id="group__enum_1gga79d3ab5282ad51728a40fc5b30fc332da1e423792b09e6cba40ad7462b8e2f5a1" prot="public">
 188           <name>piece_type_unknown</name>
 189           <briefdescription>
 190           </briefdescription>
 191           <detaileddescription>
 192           </detaileddescription>
 193         </enumvalue>
 194         <briefdescription>
 195 <para>Enumerates types of pieces (parts of buffer) around geometries. </para>        </briefdescription>
 196         <detaileddescription>
 197         </detaileddescription>
 198         <inbodydescription>
 199         </inbodydescription>
 200         <location file="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" line="63" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" bodystart="62" bodyend="71"/>
 201       </memberdef>
 202       <memberdef kind="enum" id="group__enum_1ga98d7cec6a125ad7edf42a3c08e2853dd" prot="public" static="no">
 203         <name>result_code</name>
 204         <enumvalue id="group__enum_1gga98d7cec6a125ad7edf42a3c08e2853ddaeef2d3b4e82be420b7b9bf0f0a05a540" prot="public">
 205           <name>result_normal</name>
 206           <briefdescription>
 207           </briefdescription>
 208           <detaileddescription>
 209           </detaileddescription>
 210         </enumvalue>
 211         <enumvalue id="group__enum_1gga98d7cec6a125ad7edf42a3c08e2853ddad0b7a74aa0258eb3543c5c7daf2e6a04" prot="public">
 212           <name>result_error_numerical</name>
 213           <briefdescription>
 214           </briefdescription>
 215           <detaileddescription>
 216           </detaileddescription>
 217         </enumvalue>
 218         <enumvalue id="group__enum_1gga98d7cec6a125ad7edf42a3c08e2853ddac43b56490ccd3b15a97208b66f3dd681" prot="public">
 219           <name>result_no_output</name>
 220           <briefdescription>
 221           </briefdescription>
 222           <detaileddescription>
 223           </detaileddescription>
 224         </enumvalue>
 225         <briefdescription>
 226 <para>Enumerates types of result codes from buffer strategies. </para>        </briefdescription>
 227         <detaileddescription>
 228         </detaileddescription>
 229         <inbodydescription>
 230         </inbodydescription>
 231         <location file="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" line="91" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/strategies/buffer.hpp" bodystart="90" bodyend="95"/>
 232       </memberdef>
 233       <memberdef kind="enum" id="group__enum_1ga8f93f0b6945c2ebb9f8a4bb53019a0d8" prot="public" static="no">
 234         <name>validity_failure_type</name>
 235         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8ad799abcd8ac589c3e2500b7bbd1e6334" prot="public">
 236           <name>no_failure</name>
 237           <initializer>= 0</initializer>
 238           <briefdescription>
 239           </briefdescription>
 240           <detaileddescription>
 241 <para>The geometry is valid </para>          </detaileddescription>
 242         </enumvalue>
 243         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8a9b7cd8df6dac3078c1dee47e7cbd0709" prot="public">
 244           <name>failure_few_points</name>
 245           <initializer>= 10</initializer>
 246           <briefdescription>
 247           </briefdescription>
 248           <detaileddescription>
 249 <para>The geometry has a very small number of points, e.g., less than 2 for linestrings, less than 3 for open rings, a closed multi-polygon that contains a polygon with less than 4 points, etc. (applies to linestrings, rings, polygons, multi-linestrings and multi-polygons) </para>          </detaileddescription>
 250         </enumvalue>
 251         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8a73b19bdd2d80e479bfd6eeee2222da56" prot="public">
 252           <name>failure_wrong_topological_dimension</name>
 253           <initializer>= 11</initializer>
 254           <briefdescription>
 255           </briefdescription>
 256           <detaileddescription>
 257 <para>The topological dimension of the geometry is smaller than its dimension, e.g., a linestring with 3 identical points, an open polygon with an interior ring consisting of 3 collinear points, etc. (applies to linear and areal geometries, including segments and boxes) </para>          </detaileddescription>
 258         </enumvalue>
 259         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8a316c3e4c46e746c679525750e1050224" prot="public">
 260           <name>failure_spikes</name>
 261           <initializer>= 12</initializer>
 262           <briefdescription>
 263           </briefdescription>
 264           <detaileddescription>
 265 <para>The geometry contains spikes (applies to linear and areal geometries) </para>          </detaileddescription>
 266         </enumvalue>
 267         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8a8af5f9ddd5eb89d21a7b27c7a182fceb" prot="public">
 268           <name>failure_duplicate_points</name>
 269           <initializer>= 13</initializer>
 270           <briefdescription>
 271           </briefdescription>
 272           <detaileddescription>
 273 <para>The geometry has (consecutive) duplicate points (applies to areal geometries only) </para>          </detaileddescription>
 274         </enumvalue>
 275         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8ae58e4a68b24407dfba4145cd31dac494" prot="public">
 276           <name>failure_not_closed</name>
 277           <initializer>= 20</initializer>
 278           <briefdescription>
 279           </briefdescription>
 280           <detaileddescription>
 281 <para>The geometry is defined as closed, the starting/ending points are not equal (applies to areal geometries only) </para>          </detaileddescription>
 282         </enumvalue>
 283         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8a15a1c5e9922f20f1b1e9bd12ab26e4bc" prot="public">
 284           <name>failure_self_intersections</name>
 285           <initializer>= 21</initializer>
 286           <briefdescription>
 287           </briefdescription>
 288           <detaileddescription>
 289 <para>The geometry has invalid self-intersections. (applies to areal geometries only) </para>          </detaileddescription>
 290         </enumvalue>
 291         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8a4869614bcd34cce68f9e657c59ed3351" prot="public">
 292           <name>failure_wrong_orientation</name>
 293           <initializer>= 22</initializer>
 294           <briefdescription>
 295           </briefdescription>
 296           <detaileddescription>
 297 <para>The actual orientation of the geometry is different from the one defined (applies to areal geometries only) </para>          </detaileddescription>
 298         </enumvalue>
 299         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8ac69af9fa40a267af8911647df8f20946" prot="public">
 300           <name>failure_interior_rings_outside</name>
 301           <initializer>= 30</initializer>
 302           <briefdescription>
 303           </briefdescription>
 304           <detaileddescription>
 305 <para>The geometry contains interior rings that lie outside the exterior ring (applies to polygons and multi-polygons only) </para>          </detaileddescription>
 306         </enumvalue>
 307         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8aaff1555fb9bc178d97c16f856b4bd282" prot="public">
 308           <name>failure_nested_interior_rings</name>
 309           <initializer>= 31</initializer>
 310           <briefdescription>
 311           </briefdescription>
 312           <detaileddescription>
 313 <para>The geometry has nested interior rings (applies to polygons and multi-polygons only) </para>          </detaileddescription>
 314         </enumvalue>
 315         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8a6b9cbda3e4d8f0ada38b1927f1fdc96c" prot="public">
 316           <name>failure_disconnected_interior</name>
 317           <initializer>= 32</initializer>
 318           <briefdescription>
 319           </briefdescription>
 320           <detaileddescription>
 321 <para>The interior of the geometry is disconnected (applies to polygons and multi-polygons only) </para>          </detaileddescription>
 322         </enumvalue>
 323         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8ace858388cbb736c3b6e83ffd8bbcd3b4" prot="public">
 324           <name>failure_intersecting_interiors</name>
 325           <initializer>= 40</initializer>
 326           <briefdescription>
 327           </briefdescription>
 328           <detaileddescription>
 329 <para>The multi-polygon contains polygons whose interiors are not disjoint (applies to multi-polygons only) </para>          </detaileddescription>
 330         </enumvalue>
 331         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8ac785a27ddd7417b1d3e525a435a6b1e5" prot="public">
 332           <name>failure_wrong_corner_order</name>
 333           <initializer>= 50</initializer>
 334           <briefdescription>
 335           </briefdescription>
 336           <detaileddescription>
 337 <para>The top-right corner of the box is lexicographically smaller than its bottom-left corner (applies to boxes only) </para>          </detaileddescription>
 338         </enumvalue>
 339         <enumvalue id="group__enum_1gga8f93f0b6945c2ebb9f8a4bb53019a0d8ab214fa3c0df702224cea9854f3b74f63" prot="public">
 340           <name>failure_invalid_coordinate</name>
 341           <initializer>= 60</initializer>
 342           <briefdescription>
 343           </briefdescription>
 344           <detaileddescription>
 345 <para>The geometry has at least one point with an invalid coordinate (for example, the coordinate is a NaN) </para>          </detaileddescription>
 346         </enumvalue>
 347         <briefdescription>
 348 <para>Enumerates the possible validity failure types for a geometry. </para>        </briefdescription>
 349         <detaileddescription>
 350 <para>The enumeration validity_failure_type enumerates the possible reasons for which a geometry may be found as invalid by the is_valid algorithm. Besides the values that indicate invalidity, there is an additional value (no_failure) that indicates validity.</para><para> <qbk>
 351 [heading See also]
 352 [link geometry.reference.algorithms.is_valid The is_valid
 353 algorithm taking a reference to validity_failure_type as second argument]
 354 </qbk>  </para>        </detaileddescription>
 355         <inbodydescription>
 356         </inbodydescription>
 357         <location file="/home/ubuntu/boost/boost/geometry/algorithms/validity_failure_type.hpp" line="34" column="1" bodyfile="/home/ubuntu/boost/boost/geometry/algorithms/validity_failure_type.hpp" bodystart="33" bodyend="85"/>
 358       </memberdef>
 359       </sectiondef>
 360     <briefdescription>
 361     </briefdescription>
 362     <detaileddescription>
 363     </detaileddescription>
 364   </compounddef>
 365 </doxygen>