Boost.Geometry    Boost C++ Libraries
Enumerations
enum: enumerations

Enumerations

enum  boost::geometry::strategy::buffer::buffer_side_selector { boost::geometry::strategy::buffer::buffer_side_left, boost::geometry::strategy::buffer::buffer_side_right }
 Enumerates options for side of buffer (left/right w.r.t. directed segment) More...
 
enum  boost::geometry::closure_selector { boost::geometry::open = 0, boost::geometry::closed = 1, boost::geometry::closure_undertermined = -1 }
 Enumerates options for defining if polygons are open or closed. More...
 
enum  boost::geometry::strategy::buffer::join_selector { boost::geometry::strategy::buffer::join_convex, boost::geometry::strategy::buffer::join_concave, boost::geometry::strategy::buffer::join_continue, boost::geometry::strategy::buffer::join_spike }
 Enumerates types of joins. More...
 
enum  boost::geometry::order_selector { boost::geometry::clockwise = 1, boost::geometry::counterclockwise = 2, boost::geometry::order_undetermined = 0 }
 Enumerates options for the order of points within polygons. More...
 
enum  boost::geometry::strategy::buffer::piece_type {
  boost::geometry::strategy::buffer::buffered_segment, boost::geometry::strategy::buffer::buffered_join, boost::geometry::strategy::buffer::buffered_round_end, boost::geometry::strategy::buffer::buffered_flat_end,
  boost::geometry::strategy::buffer::buffered_point, boost::geometry::strategy::buffer::buffered_concave, boost::geometry::strategy::buffer::piece_type_unknown
}
 Enumerates types of pieces (parts of buffer) around geometries. More...
 
enum  boost::geometry::strategy::buffer::result_code { boost::geometry::strategy::buffer::result_normal, boost::geometry::strategy::buffer::result_error_numerical, boost::geometry::strategy::buffer::result_no_output }
 Enumerates types of result codes from buffer strategies. More...
 
enum  boost::geometry::validity_failure_type {
  boost::geometry::no_failure = 0, boost::geometry::failure_few_points = 10, boost::geometry::failure_wrong_topological_dimension = 11, boost::geometry::failure_spikes = 12,
  boost::geometry::failure_duplicate_points = 13, boost::geometry::failure_not_closed = 20, boost::geometry::failure_self_intersections = 21, boost::geometry::failure_wrong_orientation = 22,
  boost::geometry::failure_interior_rings_outside = 30, boost::geometry::failure_nested_interior_rings = 31, boost::geometry::failure_disconnected_interior = 32, boost::geometry::failure_intersecting_interiors = 40,
  boost::geometry::failure_wrong_corner_order = 50, boost::geometry::failure_invalid_coordinate = 60
}
 Enumerates the possible validity failure types for a geometry. More...
 

Detailed Description

Enumeration Type Documentation

Enumerates options for defining if polygons are open or closed.

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

Enumerator
open 

Rings are open: first point and last point are different, algorithms close them explicitly on the fly

closed 

Rings are closed: first point and last point must be the same.

closure_undertermined 

(Not yet implemented): algorithms first figure out if ring must be closed on the fly

Enumerates options for the order of points within polygons.

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 point_order metafunction. The point_order metafunction defines a value, which is one of the values enumerated in the order_selector

Enumerator
clockwise 

Points are ordered clockwise.

counterclockwise 

Points are ordered counter clockwise.

order_undetermined 

Points might be stored in any order, algorithms will determine it on the fly (not yet supported)

Enumerates the possible validity failure types for a geometry.

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.

Enumerator
no_failure 

The geometry is valid

failure_few_points 

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)

failure_wrong_topological_dimension 

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)

failure_spikes 

The geometry contains spikes (applies to linear and areal geometries)

failure_duplicate_points 

The geometry has (consecutive) duplicate points (applies to areal geometries only)

failure_not_closed 

The geometry is defined as closed, the starting/ending points are not equal (applies to areal geometries only)

failure_self_intersections 

The geometry has invalid self-intersections. (applies to areal geometries only)

failure_wrong_orientation 

The actual orientation of the geometry is different from the one defined (applies to areal geometries only)

failure_interior_rings_outside 

The geometry contains interior rings that lie outside the exterior ring (applies to polygons and multi-polygons only)

failure_nested_interior_rings 

The geometry has nested interior rings (applies to polygons and multi-polygons only)

failure_disconnected_interior 

The interior of the geometry is disconnected (applies to polygons and multi-polygons only)

failure_intersecting_interiors 

The multi-polygon contains polygons whose interiors are not disjoint (applies to multi-polygons only)

failure_wrong_corner_order 

The top-right corner of the box is lexicographically smaller than its bottom-left corner (applies to boxes only)

failure_invalid_coordinate 

The geometry has at least one point with an invalid coordinate (for example, the coordinate is a NaN)

Enumerates options for side of buffer (left/right w.r.t. directed segment)

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)

Enumerator
buffer_side_left 
buffer_side_right 

Enumerates types of pieces (parts of buffer) around geometries.

Enumerator
buffered_segment 
buffered_join 
buffered_round_end 
buffered_flat_end 
buffered_point 
buffered_concave 
piece_type_unknown 

Enumerates types of joins.

Enumerator
join_convex 
join_concave 
join_continue 
join_spike 

Enumerates types of result codes from buffer strategies.

Enumerator
result_normal 
result_error_numerical 
result_no_output 

April 2, 2011

Copyright © 2007-2011 Barend Gehrels, Amsterdam, the Netherlands
Copyright © 2008-2011 Bruno Lalande, Paris, France
Copyright © 2009-2010 Mateusz Loskot, London, UK
Documentation is generated by Doxygen