MongoDB C++ Driver legacy-1.1.2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
mongo::geo::Polygon< TCoordinates > Class Template Reference
+ Inheritance diagram for mongo::geo::Polygon< TCoordinates >:

Public Member Functions

 Polygon (const BSONObj &bson)
 Polygon constructor.
 
 Polygon (const std::vector< LineString< TCoordinates > > &linearRings)
 Polygon constructor.
 
virtual BSONObj toBSON () const
 Obtain a BSON representation of the polygon.
 
virtual BoundingBox< TCoordinates > getBoundingBox () const
 Obtain the bounding box surrounding this Polygon.
 
virtual GeoObjType getType () const
 Get the geometry type of this object.
 
std::vector< Point< TCoordinates > > getPoints () const
 Obtain the points that make up this Polygon.
 
std::vector< LineString< TCoordinates > > getLinearRings () const
 Obtain the linear rings that make up this Polygon.
 
virtual BSONObj toBSON () const =0
 Obtain a BSON representation of this GeoObj.
 
virtual BoundingBox< TCoordinates > getBoundingBox () const =0
 Obtain the bounding box of this GeoObj.
 
virtual GeoObjType getType () const =0
 Get the geometry type of this object.
 

Additional Inherited Members

- Static Protected Member Functions inherited from mongo::geo::Geometry< TCoordinates >
static BoundingBox< TCoordinates > * computeBoundingBox (const std::vector< Point< TCoordinates > > &points)
 Compute the bounding box around the given points.
 
static BoundingBox< TCoordinates > * computeBoundingBox (const std::vector< BoundingBox< TCoordinates > > &bboxes)
 Compute the smallest bounding box that contains the given bounding boxes.
 
static BoundingBox< TCoordinates > * parseBoundingBox (const BSONObj &bson)
 Parses the bounding box defined by the given geometry shape, represented in BSON.
 

Constructor & Destructor Documentation

◆ Polygon() [1/2]

template<typename TCoordinates >
mongo::geo::Polygon< TCoordinates >::Polygon ( const BSONObj bson)
explicit

Polygon constructor.

Parameters
bsonA BSON representation of the polygon.

◆ Polygon() [2/2]

template<typename TCoordinates >
mongo::geo::Polygon< TCoordinates >::Polygon ( const std::vector< LineString< TCoordinates > > &  linearRings)
explicit

Polygon constructor.

Parameters
linearRingsThe linear rings that define this polygon. The first element represents the exterior linear ring. Any subsequent elements represent interior rings (or holes).

Member Function Documentation

◆ getBoundingBox()

template<typename TCoordinates >
BoundingBox< TCoordinates > mongo::geo::Polygon< TCoordinates >::getBoundingBox
virtual

Obtain the bounding box surrounding this Polygon.

Returns
A bounding box surrounding this Polygon.

Implements mongo::geo::GeoObj< TCoordinates >.

◆ getLinearRings()

template<typename TCoordinates >
std::vector< LineString< TCoordinates > > mongo::geo::Polygon< TCoordinates >::getLinearRings

Obtain the linear rings that make up this Polygon.

Returns
a vector of LineStrings that define the linear rings making up this Polygon.

◆ getPoints()

template<typename TCoordinates >
std::vector< Point< TCoordinates > > mongo::geo::Polygon< TCoordinates >::getPoints

Obtain the points that make up this Polygon.

Returns
a vector of points making up this Polygon.

◆ getType()

template<typename TCoordinates >
virtual GeoObjType mongo::geo::Polygon< TCoordinates >::getType ( ) const
inlinevirtual

Get the geometry type of this object.

Returns
GeoObjType_Polygon

Implements mongo::geo::GeoObj< TCoordinates >.

◆ toBSON()

template<typename TCoordinates >
virtual BSONObj mongo::geo::Polygon< TCoordinates >::toBSON ( ) const
inlinevirtual

Obtain a BSON representation of the polygon.

Returns
a BSON representation of the polygon.

Implements mongo::geo::GeoObj< TCoordinates >.


The documentation for this class was generated from the following file: