A k-dimensional point. More...

#include <PointKd.h>

Inheritance diagram for te::gm::PointKd:

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. More...

const double &	getCoord (std::size_t i) const
	It returns the i-th coordinate value. More...

double &	getCoord (std::size_t i)
	It returns the i-th coordinate value. More...

PointKd &	operator= (const PointKd &rhs)
	Assignment operator. More...

TE_DEFINE_VISITABLE	PointKd (unsigned int k, int srid=0, Envelope *mbr=0)
	it constructs a new point with k-dimension. More...

	PointKd (const PointKd &rhs)
	Copy constructor. More...

std::size_t	size () const
	It returns the number of coordinates of the point. More...

	~PointKd ()
	Destructor. More...

Re-Implementation from AbstractData
Methods re-Implementated from AbstractData.
te::dt::AbstractData *	clone () const
	It clones the point. More...

Re-Implementation from AbstractPoint
Methods re-Implementated from AbstractPoint.
const double &	getX () const
	It returns the point x-coordinate value. More...

void	setX (const double &x)
	It sets the point x-coordinate value. More...

const double &	getY () const
	It returns the point y-coordinate value. More...

void	setY (const double &y)
	It sets the point y-coordinate value. More...

const double &	getZ () const
	It returns the point z-coordinate value, if it has one or TE_DOUBLE_NOT_A_NUMBER otherwise. More...

void	setZ (const double &z)
	It sets the point z-coordinate value. More...

const double &	getM () const
	It returns TE_DOUBLE_NOT_A_NUMBER. More...

void	setM (const double &m)
	It doesn't perform any operation in a Kd point. More...

Re-Implmentation of methods from Geometry class
Re-Implmentation of basic methods from Geometry class.
Dimensionality	getDimension () const throw ()
	Points are 0-dimensional objects. More...

const std::string &	getGeometryType () const throw ()
	The name of instantiable subtype is: Point. More...

void	setSRID (int srid) throw ()
	It sets the Spatial Reference System ID of the Point. More...

void	transform (int srid) throw (te::common::Exception)
	It converts the coordinate values of the point to the new spatial reference system. More...

void	computeMBR (bool cascade) const throw ()
	It computes the minimum bounding rectangle for the point. More...

std::size_t	getNPoints () const throw ()
	it returns the number of points (vertexes) in the geometry. More...

Basic Geometry Methods
Basic methods on geometric objects.
int	getCoordinateDimension () const throw ()
	It returns the number of measurements or axes needed to describe a position in a coordinate system. More...

GeomType	getGeomTypeId () const throw ()
	It returns the geometry subclass type identifier. More...

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

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

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

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

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

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

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

virtual bool	isEmpty () const throw (std::exception)
	It returns true if this geometric object is the empty Geometry. More...

virtual bool	isSimple () const throw (std::exception)
	It returns true if this geometric object has no anomalous points, such as self intersection or self tangency. More...

virtual bool	isValid () const throw (std::exception)
	It tells if the geometry is well formed. More...

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

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

virtual Geometry *	getBoundary () const throw (std::exception)
	It returns the geometry boundary. More...

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 throw (std::exception)
	It returns true if the geometry object is spatially equal to rhs geometry. More...

virtual bool	disjoint (const Geometry *const rhs) const throw (std::exception)
	It returns true if the geometry object is spatially disjoint from rhs geometry. More...

virtual bool	intersects (const Geometry *const rhs) const throw (std::exception)
	It returns true if the geometry object spatially intersects rhs geometry. More...

virtual bool	touches (const Geometry *const rhs) const throw (std::exception)
	It returns true if the geometry object spatially touches rhs geometry. More...

virtual bool	crosses (const Geometry *const rhs) const throw (std::exception)
	It returns true if the geometry object spatially crosses rhs geometry. More...

virtual bool	within (const Geometry *const rhs) const throw (std::exception)
	It returns true if the geometry object is spatially within rhs geometry. More...

virtual bool	contains (const Geometry *const rhs) const throw (std::exception)
	It returns true if this geometry object spatially contains rhs geometry. More...

virtual bool	overlaps (const Geometry *const rhs) const throw (std::exception)
	It returns true if this geometry object spatially overlaps rhs geometry. More...

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

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

virtual bool	covers (const Geometry *const rhs) const throw (std::exception)
	It returns true if this geometry object spatially covers the rhs geometry. More...

virtual bool	coveredBy (const Geometry *const rhs) const throw (std::exception)
	It returns true if this geometry object is spatially covered by rhs geometry. More...

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

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

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

virtual Geometry *	buffer (const double &distance) const throw (std::exception)
	This method calculates the buffer of a geometry. More...

virtual Geometry *	buffer (const double &distance, int quadrantSegments) const throw (std::exception)
	This method calculates the buffer of a geometry. More...

virtual Geometry *	buffer (const double &distance, int quadrantSegments, BufferCapStyle endCapStyle) const throw (std::exception)
	This method calculates the buffer of a geometry. More...

virtual Geometry *	convexHull () const throw (std::exception)
	This method calculates the Convex Hull of a geometry. More...

virtual Geometry *	intersection (const Geometry *const rhs) const throw (std::exception)
	It returns a geometric object that represents the point set intersection with another geometry. More...

virtual Geometry *	Union (const Geometry *const rhs) const throw (std::exception)
	It returns a geometric object that represents the point set union with another geometry. More...

virtual Geometry *	difference (const Geometry *const rhs) const throw (std::exception)
	It returns a geometric object that represents the point set difference with another geometry. More...

virtual Geometry *	symDifference (const Geometry *const rhs) const throw (std::exception)
	It returns a geometric object that represents the point set symetric difference with another geometry. More...

virtual bool	dWithin (const Geometry *const rhs, const double &distance) const throw (std::exception)
	It returns true if the geometries are within the specified distance. More...

AbstractData Re-implementation
Methods re-implemneted from AbstractData.
int	getTypeCode () const
	It returns the data type code associated to the data value. More...

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

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). More...

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

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

Protected Attributes
GeomType	m_gType
	Internal geometry type. More...

Envelope *	m_mbr
	The geometry minimum bounding rectangle. More...

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

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

static const double	sm_notNumber
	Just a special value to return in the case of an invalid geometry. More...

static const std::string	sm_typeName
	Geometry type name for AbstractPoint. More...

Private Attributes
std::vector< double >	m_coords
	The array of coordinates. More...

Detailed Description

A k-dimensional point.

Definition at line 53 of file PointKd.h.

Member Typedef Documentation

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

inherited

Definition at line 58 of file BaseVisitable.h.

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

inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

TE_DEFINE_VISITABLE te::gm::PointKd::PointKd	(	unsigned int	k,
		int	srid = `0`,
		Envelope *	mbr = `0`
	)

it constructs a new point with k-dimension.

Parameters

k	The number of dimensions.
srid	The Spatial Reference System ID associated to the point.
mbr	The minimum bounding rectangle of this point (i.e., its envelope).

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

Copy constructor.

Parameters

rhs	The other geometry.

te::gm::PointKd::~PointKd ( )

inline

Destructor.

Definition at line 76 of file PointKd.h.

Member Function Documentation

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.

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

inherited

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.

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

inherited

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

Returns: The WKT for the Geometry.

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

virtualinherited

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.

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

virtualinherited

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.

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

virtualinherited

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.

te::dt::AbstractData* te::gm::PointKd::clone ( ) const

virtual

It clones the point.

Returns: A copy of the given point.

Note: The caller of this method will take the ownership of the returned point.; The cloned point will not have the MBR computed. This will save time when you are just cloning a geometry and don't intend to waste time computing the bounding box. If you have another suggestion, please, let me know.

Implements te::dt::AbstractData.

void te::gm::AbstractPoint::computeMBR	(	bool	cascade	)	const
throw	(
	)

virtualinherited

It computes the minimum bounding rectangle for the point.

Parameters

cascade For points this flag doesn't have effect.

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

Implements te::gm::Geometry.

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

virtualinherited

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.

virtual Geometry* te::gm::Geometry::convexHull	(		)	const
throw	(	std::exception
	)

virtualinherited

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.

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

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

virtualinherited

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.

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

virtualinherited

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.

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

virtualinherited

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.

virtual Geometry* te::gm::Geometry::difference	(	const Geometry *const	rhs	)	const
throw	(	std::exception
	)

virtualinherited

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.

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

virtualinherited

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.

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

virtualinherited

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.

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

virtualinherited

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.

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

virtualinherited

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.

virtual Geometry* te::gm::Geometry::getBoundary	(		)	const
throw	(	std::exception
	)

virtualinherited

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.

const double& te::gm::PointKd::getCoord ( std::size_t i ) const

inline

It returns the i-th coordinate value.

Parameters

i	The index of the desired coordinate value.

Returns: The i-th coordinate value.

Definition at line 94 of file PointKd.h.

double& te::gm::PointKd::getCoord ( std::size_t i )

inline

It returns the i-th coordinate value.

Parameters

i	The index of the desired coordinate value.

Returns: The i-th coordinate value.

Definition at line 103 of file PointKd.h.

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

inherited

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!

Dimensionality te::gm::AbstractPoint::getDimension	(	)	const
throw	(
	)

virtualinherited

Points are 0-dimensional objects.

Returns: te::gm::P (0-dimensional)

Implements te::gm::Geometry.

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

inherited

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.

const std::string& te::gm::AbstractPoint::getGeometryType	(	)	const
throw	(
	)

virtualinherited

The name of instantiable subtype is: Point.

Returns: The name of instantiable subtype is: Point.

Implements te::gm::Geometry.

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

inlineinherited

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 178 of file Geometry.h.

Referenced by te::rst::PolygonIterator< T >::decompose(), and te::rst::PolygonIterator< T >::setNextLine().

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

staticinherited

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

Parameters

stype The geometry type name.

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

Note: If the type is unknow it returns UnknownGeometryType.

const double& te::gm::PointKd::getM ( ) const

virtual

It returns TE_DOUBLE_NOT_A_NUMBER.

Returns: TE_DOUBLE_NOT_A_NUMBER.

Implements te::gm::AbstractPoint.

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

inherited

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.

Referenced by te::rst::PolygonIterator< T >::PolygonIterator().

std::size_t te::gm::AbstractPoint::getNPoints	(	)	const
throw	(
	)

inlinevirtualinherited

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

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

Note: TerraLib extended method.

Implements te::gm::Geometry.

Definition at line 212 of file AbstractPoint.h.

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

inlineinherited

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 189 of file Geometry.h.

Referenced by te::rst::PolygonIterator< T >::decompose(), te::rst::LineIterator< T >::LineIterator(), te::rst::PolygonIterator< T >::PolygonIterator(), and te::rst::PolygonIterator< T >::setNextLine().

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

virtualinherited

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.

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

inherited

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.

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

inherited

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.

const double& te::gm::PointKd::getX ( ) const

virtual

It returns the point x-coordinate value.

Returns: The x-coordinate value for this point.

Implements te::gm::AbstractPoint.

const double& te::gm::PointKd::getY ( ) const

virtual

It returns the point y-coordinate value.

Returns: The y-coordinate value for this point.

Implements te::gm::AbstractPoint.

const double& te::gm::PointKd::getZ ( ) const

virtual

It returns the point z-coordinate value, if it has one or TE_DOUBLE_NOT_A_NUMBER otherwise.

Returns: The z-coordinate value for this point.

Implements te::gm::AbstractPoint.

virtual Geometry* te::gm::Geometry::intersection	(	const Geometry *const	rhs	)	const
throw	(	std::exception
	)

virtualinherited

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.

Referenced by te::rst::LineIterator< T >::LineIterator(), and te::rst::PolygonIterator< T >::setNextLine().

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

virtualinherited

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.

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

inherited

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

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

virtual bool te::gm::Geometry::isEmpty	(		)	const
throw	(	std::exception
	)

virtualinherited

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.

Referenced by te::rst::PolygonIterator< T >::setNextLine().

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

staticinherited

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.

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

inherited

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

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

virtual bool te::gm::Geometry::isSimple	(		)	const
throw	(	std::exception
	)

virtualinherited

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.

virtual bool te::gm::Geometry::isValid	(		)	const
throw	(	std::exception
	)

virtualinherited

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.

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

staticinherited

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!

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

inlinevirtualinherited

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 611 of file Geometry.h.

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

virtualinherited

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::LineString, te::gm::CircularString, te::gm::CompoundCurve, te::gm::MultiPoint, te::gm::PointM, te::gm::PointZM, and te::gm::MultiLineString.

PointKd& te::gm::PointKd::operator= ( const PointKd & rhs )

Assignment operator.

Parameters

rhs	The other geometry.

Returns: A reference for this.

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

virtualinherited

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.

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

virtualinherited

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.

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

virtualinherited

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.

void te::gm::PointKd::setM ( const double & m )

virtual

It doesn't perform any operation in a Kd point.

Parameters

m	The m-coordinate value for this point.

Implements te::gm::AbstractPoint.

void te::gm::AbstractPoint::setSRID	(	int	srid	)
throw	(
	)

virtualinherited

It sets the Spatial Reference System ID of the Point.

Parameters

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

Note: TerraLib extended method.

Implements te::gm::Geometry.

void te::gm::PointKd::setX ( const double & x )

virtual

It sets the point x-coordinate value.

Parameters

x	The x-coordinate value for this point.

Implements te::gm::AbstractPoint.

void te::gm::PointKd::setY ( const double & y )

virtual

It sets the point y-coordinate value.

Parameters

y	The y-coordinate value for this point.

Implements te::gm::AbstractPoint.

void te::gm::PointKd::setZ ( const double & z )

virtual

It sets the point z-coordinate value.

Parameters

z	The z-coordinate value for this point.

Implements te::gm::AbstractPoint.

std::size_t te::gm::PointKd::size ( ) const

inline

It returns the number of coordinates of the point.

Returns: The number of coordinates of the point.

Definition at line 110 of file PointKd.h.

virtual Geometry* te::gm::Geometry::symDifference	(	const Geometry *const	rhs	)	const
throw	(	std::exception
	)

virtualinherited

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.

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

inlinevirtualinherited

It returns the data value in a WKT representation.

Returns: The data value in a WKT representation.

Implements te::dt::AbstractData.

Definition at line 858 of file Geometry.h.

Referenced by te::rst::PolygonIterator< T >::decompose().

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

virtualinherited

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.

void te::gm::AbstractPoint::transform	(	int	srid	)
throw	(	te::common::Exception
	)

virtualinherited

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

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

Parameters

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

Exceptions

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

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

Implements te::gm::Geometry.

virtual Geometry* te::gm::Geometry::Union	(	const Geometry *const	rhs	)	const
throw	(	std::exception
	)

virtualinherited

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.

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

virtualinherited

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.

Member Data Documentation

std::vector<double> te::gm::PointKd::m_coords

private

The array of coordinates.

Definition at line 199 of file PointKd.h.

GeomType te::gm::Geometry::m_gType

protectedinherited

Internal geometry type.

Definition at line 864 of file Geometry.h.

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

mutableprotectedinherited

The geometry minimum bounding rectangle.

Definition at line 866 of file Geometry.h.

int te::gm::Geometry::m_srid

protectedinherited

The Spatial Reference System code associated to the Geometry.

Definition at line 865 of file Geometry.h.

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

staticprotectedinherited

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

Definition at line 868 of file Geometry.h.

const double te::gm::AbstractPoint::sm_notNumber

staticprotectedinherited

Just a special value to return in the case of an invalid geometry.

Definition at line 220 of file AbstractPoint.h.

const std::string te::gm::AbstractPoint::sm_typeName

staticprotectedinherited

Geometry type name for AbstractPoint.

Definition at line 218 of file AbstractPoint.h.

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

/home/castejon/castejon_files/develop/terralib5/git_master/terralib5/src/terralib/geometry/PointKd.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation