Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards. More...

#include <Geometry.h>

Inheritance diagram for te::gm::Geometry:

Public Types
typedef void	ReturnType

typedef Visitor	VisitorType

Public Member Functions
virtual ReturnType	accept (VisitorType &guest) const=0
	It call the visit method from the guest object.

virtual AbstractData *	clone () const =0
	It returns a clone of this object.

Initializer methods on geometric objects
Methods for initializing a geometric object.
	Geometry (GeomType t, int srid=0, Envelope *mbr=0) _NOEXCEPT_OP(true)
	It initializes the Geometry with the specified spatial reference system id and envelope.

	Geometry (const Geometry &rhs) _NOEXCEPT_OP(true)
	Copy constructor.

virtual	~Geometry ()
	Virtual destructor.

virtual Geometry &	operator= (const Geometry &rhs) _NOEXCEPT_OP(true)
	Assignment operator.

Basic Geometry Methods
Basic methods on geometric objects.
virtual Dimensionality	getDimension () const _NOEXCEPT_OP(true)=0
	It returns the geometric object dimension (0, 1 or 2).

int	getCoordinateDimension () const _NOEXCEPT_OP(true)
	It returns the number of measurements or axes needed to describe a position in a coordinate system.

virtual const std::string &	getGeometryType () const _NOEXCEPT_OP(true)=0
	It returns the name of the geometry subclass.

GeomType	getGeomTypeId () const _NOEXCEPT_OP(true)
	It returns the geometry subclass type identifier.

virtual const std::string	get2DGeometryType () const _NOEXCEPT_OP(true)
	It returns the name of 2D geometry subclass.

virtual GeomType	get2DGeomTypeId () const _NOEXCEPT_OP(true)
	It returns the 2D geometry subclass type identifier.

int	getSRID () const _NOEXCEPT_OP(true)
	It returns the Spatial Reference System ID associated to this geometric object.

virtual void	setSRID (int srid) _NOEXCEPT_OP(true)=0
	It sets the Spatial Reference System ID of the geometry and all its parts if it is a GeometryCollection (or a Multi).

virtual void	transform (const int &srid) _NOEXCEPT_OP(false)
	It converts the coordinate values of the geometry to the new spatial reference system.

virtual void	convert (te::srs::Converter *converter) _NOEXCEPT_OP(false)=0
	It converts the coordinate values of the geometry to the new spatial reference system.

Geometry *	getEnvelope () const _NOEXCEPT_OP(true)
	It returns the minimum bounding rectangle (MBR) for the geometry.

const Envelope *	getMBR () const _NOEXCEPT_OP(true)
	It returns the minimum bounding rectangle for the geometry in an internal representation.

virtual void	computeMBR (bool cascade) const _NOEXCEPT_OP(true)=0
	It computes the minimum bounding rectangle for the geometry.

std::string	asText () const _NOEXCEPT_OP(true)
	It returns an string with the Well-Known Text Representation for the geometry.

char *	asBinary (std::size_t &size) const _NOEXCEPT_OP(false)
	It serializes the geometric object to a Well-known Binary Representation (WKB).

std::size_t	getWkbSize () const _NOEXCEPT_OP(true)
	It returns the size required by a WKB representation for this geometric object.

void	getWkb (char *wkb, te::common::MachineByteOrder byteOrder) const _NOEXCEPT_OP(false)
	It serializes the geometry to a WKB representation into the specified buffer.

virtual bool	isEmpty () const _NOEXCEPT_OP(false)
	It returns true if this geometric object is the empty Geometry.

virtual bool	isSimple () const _NOEXCEPT_OP(false)
	It returns true if this geometric object has no anomalous points, such as self intersection or self tangency.

virtual bool	isValid () const _NOEXCEPT_OP(false)
	It tells if the geometry is well formed.

bool	is3D () const _NOEXCEPT_OP(true)
	It returns true if this geometric object has z coordinate values.

bool	isMeasured () const _NOEXCEPT_OP(true)
	It returns true if this geometric object has m coordinate values.

bool	isCollection () const _NOEXCEPT_OP(true)
	It returns true if this geometric object is a collection.

virtual Geometry *	getBoundary () const _NOEXCEPT_OP(false)
	It returns the geometry boundary.

te::gm::Coord2D	getCentroid () const _NOEXCEPT_OP(false)
	It will get the centroid of the input geometries.

virtual std::size_t	getNPoints () const _NOEXCEPT_OP(true)=0
	it returns the number of points (vertexes) in the geometry.

Spatial Relations
Methods for testing spatial relations between geometric objects. Please, see OGC specification for a in depth definition of each spatial operation.
virtual bool	equals (const Geometry *const rhs, const bool exact=false) const _NOEXCEPT_OP(false)
	It returns true if the geometry object is spatially equal to rhs geometry.

virtual bool	disjoint (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object is spatially disjoint from rhs geometry.

virtual bool	intersects (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object spatially intersects rhs geometry.

virtual bool	touches (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object spatially touches rhs geometry.

virtual bool	crosses (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object spatially crosses rhs geometry.

virtual bool	within (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if the geometry object is spatially within rhs geometry.

virtual bool	contains (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object spatially contains rhs geometry.

virtual bool	overlaps (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object spatially overlaps rhs geometry.

virtual bool	relate (const Geometry *const rhs, const std::string &matrix) const _NOEXCEPT_OP(false)
	It returns true if this geometry object is spatially related to rhs geometry according to the pattern expressed by the intersection matrix.

virtual std::string	relate (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns the spatial relation between this geometry object and the rhs geometry.

virtual bool	covers (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object spatially covers the rhs geometry.

virtual bool	coveredBy (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns true if this geometry object is spatially covered by rhs geometry.

virtual Geometry *	locateAlong (const double &mValue) const _NOEXCEPT_OP(false)
	It returns a derived GeometryCollection value according to the specified coordinate value.

virtual Geometry *	locateBetween (const double &mStart, const double &mEnd) const _NOEXCEPT_OP(false)
	It returns a derived geometry collection value according to the range of coordinate values inclusively.

Spatial Analysis
Methods that support spatial analysis.
virtual double	distance (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns the shortest distance between any two points in the two geometry objects.

virtual Geometry *	buffer (const double &distance) const _NOEXCEPT_OP(false)
	This method calculates the buffer of a geometry.

virtual Geometry *	buffer (const double &distance, int quadrantSegments) const _NOEXCEPT_OP(false)
	This method calculates the buffer of a geometry.

virtual Geometry *	buffer (const double &distance, int quadrantSegments, BufferCapStyle endCapStyle) const _NOEXCEPT_OP(false)
	This method calculates the buffer of a geometry.

virtual Geometry *	convexHull () const _NOEXCEPT_OP(false)
	This method calculates the Convex Hull of a geometry.

virtual Geometry *	intersection (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set intersection with another geometry.

virtual Geometry *	Union (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set union with another geometry.

virtual Geometry *	difference (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set difference with another geometry.

virtual Geometry *	symDifference (const Geometry *const rhs) const _NOEXCEPT_OP(false)
	It returns a geometric object that represents the point set symetric difference with another geometry.

virtual bool	dWithin (const Geometry *const rhs, const double &distance) const _NOEXCEPT_OP(false)
	It returns true if the geometries are within the specified distance.

Static Public Member Functions
Auxiliary Methods
Auxiliary Methods.
static GeomType	getGeomTypeId (const std::string &gtype)
	It returns the TerraLib geometry type id given a type string (the type string must be in capital letters).

static std::string	getGeomTypeString (const int &gId)
	It returns the TerraLib geometry type string given a type id.

static bool	isGeomType (const std::string &stype)
	It tells if the given string is a geometry data type.

static void	loadGeomTypeId ()
	It loads the internal MAP of geometry type names to geometry type ids.

AbstractData Re-implementation
Methods re-implemneted from AbstractData.
GeomType	m_gType
	Internal geometry type.

int	m_srid
	The Spatial Reference System code associated to the Geometry.

Envelope *	m_mbr
	The geometry minimum bounding rectangle.

static std::map< std::string, GeomType >	sm_geomTypeMap
	A set of geometry type names (in UPPER CASE).

int	getTypeCode () const
	It returns the data type code associated to the data value.

std::string	toString () const
	It returns the data value in a WKT representation.

Detailed Description

Geometry is the root class of the geometries hierarchy, it follows OGC and ISO standards.

The geometry model follows OGC Simple Feature Specification - SFS (Simple Feature Access - Part 1: Common Architecture) and ISO SQL/MM Spatial.

See also: AbstractPoint, Point, PointM, PointZ, PointZM, PointKd, Curve, LineString, LinearRing, Line, CircularString, CompoundCurve, Surface, CurvePolygon, Polygon, Triangle, PolyhedralSurface, TIN, GeometryCollection, MultiCurve, MultiSurface, MultiPoint, MultiLineString, MultiPolygon

Note: Methods marked as extended are not from OGC or ISO specifications, but they enhances the TerraLib API.; Methods performed by another library are marked as Performed by Library-Name.

Definition at line 77 of file Geometry.h.

Member Typedef Documentation

◆ ReturnType

typedef void te::common::BaseVisitable< Visitor, void >::ReturnType

inherited

Definition at line 58 of file BaseVisitable.h.

◆ VisitorType

typedef Visitor te::common::BaseVisitable< Visitor, void >::VisitorType

inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

◆ Geometry() [1/2]

te::gm::Geometry::Geometry	(	GeomType	t,
		int	srid = 0,
		Envelope *	mbr = 0 )

It initializes the Geometry with the specified spatial reference system id and envelope.

Parameters

t	The internal geometry type.
srid	The Spatial Reference System ID associated to the geometry.
mbr	The envelope (minimum bounding rectangle of this geometry).

Note: The geometry will take the ownership of the given mbr.

References _NOEXCEPT_OP.

Referenced by te::gm::GeometryCollection::add(), buffer(), buffer(), buffer(), contains(), convexHull(), coveredBy(), covers(), crosses(), difference(), disjoint(), distance(), dWithin(), equals(), Geometry(), getBoundary(), getEnvelope(), te::gm::GeometryCollection::getGeometries(), te::gm::GeometryCollection::getGeometryN(), te::gm::GeometryCollection::getGeometryN(), intersection(), intersects(), locateAlong(), locateBetween(), operator=(), overlaps(), relate(), relate(), te::gm::GeometryCollection::setGeometryN(), symDifference(), touches(), Union(), within(), and ~Geometry().

◆ Geometry() [2/2]

te::gm::Geometry::Geometry ( const Geometry & rhs )

Copy constructor.

Parameters

rhs	The other geometry.

References _NOEXCEPT_OP, and Geometry().

◆ ~Geometry()

virtual te::gm::Geometry::~Geometry ( )

virtual

Virtual destructor.

References Geometry().

Member Function Documentation

◆ accept()

virtual ReturnType te::common::BaseVisitable< Visitor, void >::accept ( VisitorType & guest ) const

pure virtualinherited

It call the visit method from the guest object.

Parameters

guest The guest or visitor.

Returns: Any valid value define by the template type R.

◆ asBinary()

char * te::gm::Geometry::asBinary ( std::size_t & size ) const

It serializes the geometric object to a Well-known Binary Representation (WKB).

Parameters

size	The size in bytes of the returned WKB.

Returns: The WKB representation for this object.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: The WKB will be on machine byte order.; The caller of this method will take the ownership of the returned wkb. You must use "delete [] pointer" in order to free the memory pointed by returned pointer.

References _NOEXCEPT_OP, and asBinary().

Referenced by asBinary().

◆ asText()

std::string te::gm::Geometry::asText ( ) const

It returns an string with the Well-Known Text Representation for the geometry.

Returns: The WKT for the Geometry.

References _NOEXCEPT_OP, and asText().

Referenced by asText(), and toString().

◆ buffer() [1/3]

virtual Geometry * te::gm::Geometry::buffer ( const double & distance ) const

virtual

This method calculates the buffer of a geometry.

Parameters

distance Distance value.

Returns: A geometry representing all points less than or equal to the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; Performed by GEOS.

References distance(), and Geometry().

◆ buffer() [2/3]

virtual Geometry * te::gm::Geometry::buffer	(	const double &	distance,
		int	quadrantSegments ) const

virtual

This method calculates the buffer of a geometry.

Parameters

distance	Distance value.
quadrantSegments	A specified number of segments used to approximate the curves.

Returns: A geometry representing all points less than or equal to the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; TerraLib extended method.; Performed by GEOS.

References distance(), and Geometry().

◆ buffer() [3/3]

virtual Geometry * te::gm::Geometry::buffer	(	const double &	distance,
		int	quadrantSegments,
		BufferCapStyle	endCapStyle ) const

virtual

This method calculates the buffer of a geometry.

As in GEOS, the quadrantSegments argument allows controlling the accuracy of the approximation by specifying the number of line segments used to represent a quadrant of a circle.

Parameters

distance	Distance value.
quadrantSegments	A specified number of segments used to approximate the curves.
endCapStyle	It specifies the shape used at the ends of linestrings.

Returns: A geometry representing all points less than or equal to the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned Geometry.; TerraLib extended method.; Performed by GEOS.

References distance(), and Geometry().

◆ clone()

virtual AbstractData * te::dt::AbstractData::clone ( ) const

pure virtualinherited

It returns a clone of this object.

Returns: A clone of this object.

References AbstractData().

Referenced by te::dt::new_clone().

◆ computeMBR()

virtual void te::gm::Geometry::computeMBR ( bool cascade ) const

pure virtual

It computes the minimum bounding rectangle for the geometry.

Subclasses must implement this method in order to be able to compute the minimum bounding box of a specific geometry.

Parameters

cascade If true it will update the MBR for its sub-geometries.

Note: You can use this method in order to update the MBR of the Geometry.; TerraLib extended method.

Implemented in te::gm::CircularString, te::gm::CompoundCurve, te::gm::CurvePolygon, te::gm::GeometryCollection, te::gm::LineString, te::gm::Point, and te::gm::PolyhedralSurface.

References _NOEXCEPT_OP, and computeMBR().

Referenced by computeMBR().

◆ contains()

virtual bool te::gm::Geometry::contains ( const Geometry *const rhs ) const

virtual

It returns true if this geometry object spatially contains rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially contains the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, contains(), and Geometry().

Referenced by contains().

◆ convert()

virtual void te::gm::Geometry::convert ( te::srs::Converter * converter )

pure virtual

It converts the coordinate values of the geometry to the new spatial reference system.

After calling this method the geometry will be associated to the new SRID.

Parameters

converter The converter containing all the information related to the new Spatial Reference System ID used to transform the coordinates of the geometry.

Exceptions

Exception It will throw an exception if it can not do the transformation.

Note: The geometry must be associated to a valid SRID before calling this method.; If the geometry already has an associated MBR, this method will automatically update it (i. e. automatically recompute it).

Implemented in te::gm::CircularString, te::gm::CompoundCurve, te::gm::CurvePolygon, te::gm::GeometryCollection, te::gm::LineString, te::gm::Point, and te::gm::PolyhedralSurface.

◆ convexHull()

virtual Geometry * te::gm::Geometry::convexHull ( ) const

virtual

This method calculates the Convex Hull of a geometry.

Returns: A geometry representing the convex hull.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; Performed by GEOS.

References _NOEXCEPT_OP, and Geometry().

Referenced by te::rp::GetTPConvexHullArea().

◆ coveredBy()

virtual bool te::gm::Geometry::coveredBy ( const Geometry *const rhs ) const

virtual

It returns true if this geometry object is spatially covered by rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry is spatially covered by the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: TerraLib extended method.; This is not the same as within. See Max Egenhofer paper on 9-intersection matrix.; Performed by GEOS.

References _NOEXCEPT_OP, coveredBy(), and Geometry().

Referenced by coveredBy().

◆ covers()

virtual bool te::gm::Geometry::covers ( const Geometry *const rhs ) const

virtual

It returns true if this geometry object spatially covers the rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially covers the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: TerraLib extended method.; This is not the same as contains. See Max Egenhofer paper on 9-intersection matrix.; Performed by GEOS.

References _NOEXCEPT_OP, covers(), and Geometry().

Referenced by covers().

◆ crosses()

virtual bool te::gm::Geometry::crosses ( const Geometry *const rhs ) const

virtual

It returns true if the geometry object spatially crosses rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially crosses the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, crosses(), and Geometry().

Referenced by crosses().

◆ difference()

virtual Geometry * te::gm::Geometry::difference ( const Geometry *const rhs ) const

virtual

It returns a geometric object that represents the point set difference with another geometry.

Parameters

rhs	Another geometry whose difference with this geometry will be calculated.

Returns: A geometry representing the difference between the geometries.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

References _NOEXCEPT_OP, difference(), and Geometry().

Referenced by difference().

◆ disjoint()

virtual bool te::gm::Geometry::disjoint ( const Geometry *const rhs ) const

virtual

It returns true if the geometry object is spatially disjoint from rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry is spatially disjoint from the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, disjoint(), and Geometry().

Referenced by disjoint(), and te::rst::PolygonIterator< T >::getBBOXIntersectionRanges().

◆ distance()

virtual double te::gm::Geometry::distance ( const Geometry *const rhs ) const

virtual

It returns the shortest distance between any two points in the two geometry objects.

Parameters

rhs	The other geometry.

Returns: The shortest distance between any two points in the two geometries.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: Performed by GEOS.

References Geometry().

Referenced by buffer(), buffer(), buffer(), dWithin(), and te::gm::Line::setCoord().

◆ dWithin()

virtual bool te::gm::Geometry::dWithin	(	const Geometry *const	rhs,
		const double &	distance ) const

virtual

It returns true if the geometries are within the specified distance.

Parameters

rhs	The other geometry whose symetric difference with this geometry will be calculated.
distance	The distance.

Returns: True if the geometries are within the specified distance.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: TerraLib extended method.; Performed by GEOS.

References _NOEXCEPT_OP, distance(), dWithin(), and Geometry().

Referenced by dWithin().

◆ equals()

virtual bool te::gm::Geometry::equals	(	const Geometry *const	rhs,
		const bool	exact = false ) const

virtual

It returns true if the geometry object is spatially equal to rhs geometry.

Parameters

rhs	The another geometry to be compared.
exact	If true checks if this geometric object has the same vertexes in the same order of rhs geometry.

Returns: True if the geometry is spatially equal to the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, equals(), and Geometry().

Referenced by equals().

◆ get2DGeometryType()

virtual const std::string te::gm::Geometry::get2DGeometryType ( ) const

virtual

It returns the name of 2D geometry subclass.

The name of the 2D geometry subclass may be one of the following:

Returns: The name of the geometry subclass type ide.

References _NOEXCEPT_OP.

◆ get2DGeomTypeId()

virtual GeomType te::gm::Geometry::get2DGeomTypeId ( ) const

virtual

It returns the 2D geometry subclass type identifier.

GeometryType = 0
PointType = 1
LineStringType = 2
PolygonType = 3
MultiPointType = 4
MultiLineStringType = 5
MultiPolygonType = 6
GeometryCollectionType = 7
CircularStringType = 8
CompoundCurveType = 9
CurvePolygonType = 10
MultiSurfaceType = 12

Returns: The 2D geometry subclass type identifier

Note: Please, see GeomType enumeration for possible return values.; TerraLib extended method.

References _NOEXCEPT_OP, and get2DGeomTypeId().

Referenced by get2DGeomTypeId().

◆ getBoundary()

virtual Geometry * te::gm::Geometry::getBoundary ( ) const

virtual

It returns the geometry boundary.

Returns: The geometry that makes the boundary of this geometry. The caller of this method will take the ownership of the returned geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and getBoundary().

Referenced by getBoundary().

◆ getCentroid()

te::gm::Coord2D te::gm::Geometry::getCentroid ( ) const

It will get the centroid of the input geometries.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Returns: a Point containing the centroid coord.

References _NOEXCEPT_OP, and getCentroid().

Referenced by getCentroid().

◆ getCoordinateDimension()

int te::gm::Geometry::getCoordinateDimension ( ) const

It returns the number of measurements or axes needed to describe a position in a coordinate system.

It returns:

2 for a coordinate with x, y;
3 for a coordinate with x, y and z or x, y and m;
4 for a coordinate with x, y, z and m.

Returns: The number of measurements or axes needed to describe a position in a coordinate system.

Note: This is NOT the same as getDimension() method!

References _NOEXCEPT_OP, and getCoordinateDimension().

Referenced by getCoordinateDimension().

◆ getDimension()

virtual Dimensionality te::gm::Geometry::getDimension ( ) const

pure virtual

It returns the geometric object dimension (0, 1 or 2).

For a GeometryCollection it returns the largest topological dimension of the contained objects. For Point and MultiPoint this will return 0. For Curves and MultiCurves (LineString, LinearRing and MultiLineString) it will return 1. For Surfaces (Polygon, Triangle, PolyhedralSurface, TIN) and MultiSurfaces (MultiPolygon) it will return 2.

Returns: The geometric object dimension (0, 1 or 2).

Implemented in te::gm::Curve, te::gm::GeometryCollection, te::gm::MultiCurve, te::gm::MultiPoint, te::gm::MultiSurface, te::gm::Point, and te::gm::Surface.

References _NOEXCEPT_OP, and getDimension().

Referenced by getDimension().

◆ getEnvelope()

Geometry * te::gm::Geometry::getEnvelope ( ) const

It returns the minimum bounding rectangle (MBR) for the geometry.

As one can notice, the mbr is returned as a geometry, actually a polygon defined by the corner points of the bounding box [(MINX, MINY), (MAXX, MINY), (MAXX, MAXY), (MINX, MAXY), (MINX, MINY)].

Returns: The geometry envelope (or mbr).

Note: The caller of this method will take the ownership of the returned geometry.; If the MBR was not computed previously, it will compute it. Successive calls to this method will not compute the mbr anymore.

References _NOEXCEPT_OP, and Geometry().

◆ getGeometryType()

virtual const std::string & te::gm::Geometry::getGeometryType ( ) const

pure virtual

It returns the name of the geometry subclass.

The name of the geometry subclass may be one of the following:

Returns: The name of the geometry subclass type ide.

Implemented in te::gm::CircularString, te::gm::CompoundCurve, te::gm::CurvePolygon, te::gm::GeometryCollection, te::gm::LineString, te::gm::MultiLineString, te::gm::MultiPoint, te::gm::MultiPolygon, te::gm::Point, te::gm::Polygon, te::gm::PolyhedralSurface, and te::gm::TIN.

References _NOEXCEPT_OP, and getGeometryType().

Referenced by getGeometryType().

◆ getGeomTypeId() [1/2]

GeomType te::gm::Geometry::getGeomTypeId ( ) const

inline

It returns the geometry subclass type identifier.

Returns: The geometry subclass type identifier

Note: Please, see GeomType enumeration for possible return values.; TerraLib extended method.

Definition at line 182 of file Geometry.h.

References _NOEXCEPT_OP, getGeomTypeId(), and m_gType.

Referenced by getGeomTypeId(), and getGeomTypeId().

◆ getGeomTypeId() [2/2]

static GeomType te::gm::Geometry::getGeomTypeId ( const std::string & gtype )

static

It returns the TerraLib geometry type id given a type string (the type string must be in capital letters).

Parameters

gtype The geometry type name.

Returns: The geometry type id equivalent to the string name.

Note: If the type is unknow it returns UnknownGeometryType.

References getGeomTypeId().

◆ getGeomTypeString()

static std::string te::gm::Geometry::getGeomTypeString ( const int & gId )

static

It returns the TerraLib geometry type string given a type id.

Parameters

gId	The geometry type id.

Returns: The geometry type string equivalent to the id.

Note: If the type is unknow it returns UNKNOWGEOMETRYTYPE.

References getGeomTypeString().

Referenced by getGeomTypeString().

◆ getMBR()

const Envelope * te::gm::Geometry::getMBR ( ) const

It returns the minimum bounding rectangle for the geometry in an internal representation.

The mbr can be constructed when reading a geometry from a database or it can be computed internally. So, if the mbr is not already set it will compute it just when this method is called. Successive calls to this method will not compute the mbr anymore.

Returns: The envelope of this geometry (i.e., the minimum bounding rectangle).

Note: It is supposed to be faster and more useful than getting the box as a polygon geometry.; TerraLib extended method.

References _NOEXCEPT_OP, and getMBR().

Referenced by getMBR().

◆ getNPoints()

virtual std::size_t te::gm::Geometry::getNPoints ( ) const

pure virtual

it returns the number of points (vertexes) in the geometry.

Returns: The number of points (vertexes) in the geometry.

Note: TerraLib extended method.

Implemented in te::gm::CircularString, te::gm::CompoundCurve, te::gm::CurvePolygon, te::gm::GeometryCollection, te::gm::LineString, te::gm::Point, and te::gm::PolyhedralSurface.

References _NOEXCEPT_OP, and getNPoints().

Referenced by getNPoints().

◆ getSRID()

int te::gm::Geometry::getSRID ( ) const

inline

It returns the Spatial Reference System ID associated to this geometric object.

This value can be used to identify the associated Spatial Reference System.

Returns: The Spatial Reference System ID associated to this geometric object.

Note: When not set this value will be -1.

Definition at line 242 of file Geometry.h.

References _NOEXCEPT_OP, getSRID(), and m_srid.

Referenced by te::rst::PolygonIterator< T >::getScanLineIntersectionRanges(), getSRID(), te::rst::PolygonIterator< T >::initialize(), and te::rst::LineIterator< T >::LineIterator().

◆ getTypeCode()

int te::gm::Geometry::getTypeCode ( ) const

virtual

It returns the data type code associated to the data value.

Returns: The data type code associated to the data value.

Implements te::dt::AbstractData.

References getTypeCode().

Referenced by getTypeCode().

◆ getWkb()

void te::gm::Geometry::getWkb	(	char *	wkb,
		te::common::MachineByteOrder	byteOrder ) const

It serializes the geometry to a WKB representation into the specified buffer.

The wkb parameter must have at least getWkbSize() in order to be used. Don't pass a NULL pointer or a buffer smaller than the size needed. Note that the WKB will be on the specified byte order.

Parameters

wkb	The buffer where the Geometry will be serialized.
byteOrder	The byte order used to store/serialize the geometry.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: TerraLib extended method.

References _NOEXCEPT_OP, and getWkb().

Referenced by getWkb().

◆ getWkbSize()

std::size_t te::gm::Geometry::getWkbSize ( ) const

It returns the size required by a WKB representation for this geometric object.

This is the preferred method for creating a WKB. First of all, it gives you the possibility to use a pre-allocated buffer. So, this method can be used in conjunction with the getWkb method.

Returns: The size required by a WKB representation for the geometry object.

Note: TerraLib extended method.

References _NOEXCEPT_OP, and getWkbSize().

Referenced by getWkbSize().

◆ intersection()

virtual Geometry * te::gm::Geometry::intersection ( const Geometry *const rhs ) const

virtual

It returns a geometric object that represents the point set intersection with another geometry.

Parameters

rhs	The other Geometry whose intersection with this Geometry will be calculated.

Returns: A Geometry representing the intersection with this Geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and intersection().

Referenced by te::gm::Line::clone(), intersection(), and te::rst::LineIterator< T >::LineIterator().

◆ intersects()

virtual bool te::gm::Geometry::intersects ( const Geometry *const rhs ) const

virtual

It returns true if the geometry object spatially intersects rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry intersects the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and intersects().

Referenced by intersects().

◆ is3D()

bool te::gm::Geometry::is3D ( ) const

It returns true if this geometric object has z coordinate values.

Returns: True if this geometric object has z coordinate values.

References _NOEXCEPT_OP, and is3D().

Referenced by is3D().

◆ isCollection()

bool te::gm::Geometry::isCollection ( ) const

It returns true if this geometric object is a collection.

Returns: True if this geometric object is a collection.

References _NOEXCEPT_OP, and isCollection().

Referenced by isCollection().

◆ isEmpty()

virtual bool te::gm::Geometry::isEmpty ( ) const

virtual

It returns true if this geometric object is the empty Geometry.

If true, then this geometric object represents the empty point set for the coordinate space.

Returns: True if this geometric object is the empty Geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: Performed by GEOS.

References _NOEXCEPT_OP, and isEmpty().

Referenced by isEmpty().

◆ isGeomType()

static bool te::gm::Geometry::isGeomType ( const std::string & stype )

static

It tells if the given string is a geometry data type.

Parameters

stype The geometry type to be checked.

Returns: True if the given string corresponds to a geometry type.

References isGeomType().

Referenced by isGeomType().

◆ isMeasured()

bool te::gm::Geometry::isMeasured ( ) const

It returns true if this geometric object has m coordinate values.

Returns: True if this geometric object has m coordinate values.

References _NOEXCEPT_OP, and isMeasured().

Referenced by isMeasured().

◆ isSimple()

virtual bool te::gm::Geometry::isSimple ( ) const

virtual

It returns true if this geometric object has no anomalous points, such as self intersection or self tangency.

See the ISO and OGC documentation for an explanation about specific conditions of each type of geometry to be considered not simple.

Returns: True if this geometric object has no anomalous geometric points.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: Performed by GEOS.

References _NOEXCEPT_OP, and isSimple().

Referenced by isSimple().

◆ isValid()

virtual bool te::gm::Geometry::isValid ( ) const

virtual

It tells if the geometry is well formed.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Note: TerraLib extended method.; Performed by GEOS.

References _NOEXCEPT_OP, and isValid().

Referenced by isValid().

◆ loadGeomTypeId()

static void te::gm::Geometry::loadGeomTypeId ( )

static

It loads the internal MAP of geometry type names to geometry type ids.

Warning: Ths method will be automatically called when geometry module is initialized!

References loadGeomTypeId().

Referenced by loadGeomTypeId().

◆ locateAlong()

virtual Geometry * te::gm::Geometry::locateAlong ( const double & mValue ) const

inlinevirtual

It returns a derived GeometryCollection value according to the specified coordinate value.

Parameters

mValue The coordinate value.

Returns: A GeometryCollection value.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: The caller of this method will take the ownership of the returned geometry.; This method only applies to Point and Line geometries, including homogeneu collections of points or lines. For polygons this will return a NULL value.

Definition at line 695 of file Geometry.h.

References _NOEXCEPT_OP, Geometry(), locateAlong(), and locateBetween().

Referenced by locateAlong().

◆ locateBetween()

virtual Geometry * te::gm::Geometry::locateBetween	(	const double &	mStart,
		const double &	mEnd ) const

virtual

It returns a derived geometry collection value according to the range of coordinate values inclusively.

Parameters

mStart	The initial coordinate value.
mEnd	The final coordinate value.

Returns: A GeometryCollection value.

Exceptions

Exception It will throw an exception if the operation could not be performed.

Note: This method only applies to Point and Line geometries, including homogeneous collections of points or lines. For polygons this will return a NULL value.; The caller of this method will take the ownership of the returned Geometry.

Reimplemented in te::gm::CircularString, te::gm::CompoundCurve, te::gm::LineString, te::gm::MultiLineString, and te::gm::MultiPoint.

References Geometry().

Referenced by locateAlong().

◆ operator=()

virtual Geometry & te::gm::Geometry::operator= ( const Geometry & rhs )

virtual

Assignment operator.

Parameters

rhs	The right-hand-side geometry.

Returns: A reference for this.

References _NOEXCEPT_OP, and Geometry().

◆ overlaps()

virtual bool te::gm::Geometry::overlaps ( const Geometry *const rhs ) const

virtual

It returns true if this geometry object spatially overlaps rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially overlaps the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and overlaps().

Referenced by overlaps().

◆ relate() [1/2]

virtual std::string te::gm::Geometry::relate ( const Geometry *const rhs ) const

virtual

It returns the spatial relation between this geometry object and the rhs geometry.

Parameters

rhs	The another geometry to be compared.

Returns: A string where each byte is a intersection in the pattern intersection matrix of the relationship of the two objects.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: TerraLib extended method.; This method will be handy when you don't know the spatial relation in advance.; Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and relate().

◆ relate() [2/2]

virtual bool te::gm::Geometry::relate	(	const Geometry *const	rhs,
		const std::string &	matrix ) const

virtual

It returns true if this geometry object is spatially related to rhs geometry according to the pattern expressed by the intersection matrix.

It does this by testing for intersections between the interior, boundary and exterior of the two geometric objects as specified by the values in the matrix.

Parameters

rhs	The other geometry to be compared.
matrix	The intersection matrix.

Returns: True if the geometry is spatially related to the other geometry according to the pattern expressed by the intersection matrix.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and relate().

Referenced by relate(), and relate().

◆ setSRID()

virtual void te::gm::Geometry::setSRID ( int srid )

pure virtual

It sets the Spatial Reference System ID of the geometry and all its parts if it is a GeometryCollection (or a Multi).

Parameters

srid	The Spatial Reference System ID to be associated to the geometric object.

Note: This method just set the srid, it doesn't perform conversions over coordinate values.; TerraLib extended method.

Implemented in te::gm::CircularString, te::gm::CompoundCurve, te::gm::CurvePolygon, te::gm::GeometryCollection, te::gm::LineString, te::gm::Point, and te::gm::PolyhedralSurface.

◆ symDifference()

virtual Geometry * te::gm::Geometry::symDifference ( const Geometry *const rhs ) const

virtual

It returns a geometric object that represents the point set symetric difference with another geometry.

Parameters

rhs	The other geometry whose symetric difference with this geometry will be calculated.

Returns: A geometry representing the symetric difference with this geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and symDifference().

Referenced by symDifference().

◆ toString()

std::string te::gm::Geometry::toString ( void ) const

inlinevirtual

It returns the data value in a WKT representation.

Returns: The data value in a WKT representation.

Implements te::dt::AbstractData.

Definition at line 953 of file Geometry.h.

References asText(), and toString().

Referenced by toString().

◆ touches()

virtual bool te::gm::Geometry::touches ( const Geometry *const rhs ) const

virtual

It returns true if the geometry object spatially touches rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry spatially touches the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and touches().

Referenced by touches().

◆ transform()

virtual void te::gm::Geometry::transform ( const int & srid )

virtual

It converts the coordinate values of the geometry to the new spatial reference system.

After calling this method the geometry will be associated to the new SRID.

Parameters

srid	The new Spatial Reference System ID used to transform the coordinates of the geometry.

Exceptions

Exception It will throw an exception if it can not do the transformation.

Note: The geometry must be associated to a valid SRID before calling this method.; If the geometry already has an associated MBR, this method will automatically update it (i. e. automatically recompute it).

◆ Union()

virtual Geometry * te::gm::Geometry::Union ( const Geometry *const rhs ) const

virtual

It returns a geometric object that represents the point set union with another geometry.

Parameters

rhs	Another geometry whose union with this geometry will be calculated.

Returns: A geometry representing the union with this geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: The caller of this method will take the ownership of the returned Geometry.; Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and Union().

Referenced by Union().

◆ within()

virtual bool te::gm::Geometry::within ( const Geometry *const rhs ) const

virtual

It returns true if the geometry object is spatially within rhs geometry.

Parameters

rhs	The other geometry to be compared.

Returns: True if the geometry is spatially within the other geometry.

Exceptions

std::exception It will throw an exception if the operation could not be performed.

Warning: Don't call this method for a Heterogeneous GeometryCollection, otherwise, an exception will be thrown.

Note: Performed by GEOS.

References _NOEXCEPT_OP, Geometry(), and within().

Referenced by within().

Member Data Documentation

◆ m_gType

GeomType te::gm::Geometry::m_gType

protected

Internal geometry type.

Definition at line 959 of file Geometry.h.

Referenced by getGeomTypeId().

◆ m_mbr

Envelope* te::gm::Geometry::m_mbr

mutableprotected

The geometry minimum bounding rectangle.

Definition at line 961 of file Geometry.h.

◆ m_srid

int te::gm::Geometry::m_srid

protected

The Spatial Reference System code associated to the Geometry.

Definition at line 960 of file Geometry.h.

Referenced by getSRID().

◆ sm_geomTypeMap

std::map<std::string, GeomType> te::gm::Geometry::sm_geomTypeMap

staticprotected

A set of geometry type names (in UPPER CASE).

Definition at line 963 of file Geometry.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/geometry/Geometry.h

Public Types

Public Member Functions

Static Public Member Functions

AbstractData Re-implementation

Detailed Description

Member Typedef Documentation

◆ ReturnType

◆ VisitorType

Constructor & Destructor Documentation

◆ Geometry() [1/2]

◆ Geometry() [2/2]

◆ ~Geometry()

Member Function Documentation

◆ accept()

◆ asBinary()

◆ asText()

◆ buffer() [1/3]

◆ buffer() [2/3]

◆ buffer() [3/3]

◆ clone()

◆ computeMBR()

◆ contains()

◆ convert()

◆ convexHull()

◆ coveredBy()

◆ covers()

◆ crosses()

◆ difference()

◆ disjoint()

◆ distance()

◆ dWithin()

◆ equals()

◆ get2DGeometryType()

◆ get2DGeomTypeId()

◆ getBoundary()

◆ getCentroid()

◆ getCoordinateDimension()

◆ getDimension()

◆ getEnvelope()

◆ getGeometryType()

◆ getGeomTypeId() [1/2]

◆ getGeomTypeId() [2/2]

◆ getGeomTypeString()

◆ getMBR()

◆ getNPoints()

◆ getSRID()

◆ getTypeCode()

◆ getWkb()

◆ getWkbSize()

◆ intersection()

◆ intersects()

◆ is3D()

◆ isCollection()

◆ isEmpty()

◆ isGeomType()

◆ isMeasured()

◆ isSimple()

◆ isValid()

◆ loadGeomTypeId()

◆ locateAlong()

◆ locateBetween()

◆ operator=()

◆ overlaps()

◆ relate() [1/2]

◆ relate() [2/2]

◆ setSRID()

◆ symDifference()

◆ toString()

◆ touches()

◆ transform()

◆ Union()

◆ within()

Member Data Documentation

◆ m_gType

◆ m_mbr

◆ m_srid

◆ sm_geomTypeMap