A class for binary spatial operators. More...

#include <BinarySpatialOp.h>

Inheritance diagram for te::fe::BinarySpatialOp:

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.

Initializer Methods
Methods related to instantiation and destruction.
	BinarySpatialOp (const char *opName=0)
	It initializes the BinarySpatialOp.

	BinarySpatialOp (const char opName, PropertyName p, te::gm::Geometry *g)
	It initializes the BinarySpatialOp.

	BinarySpatialOp (const char opName, PropertyName p, te::gml::Envelope *e)
	It initializes the BinarySpatialOp.

virtual	~BinarySpatialOp ()
	Destructor.

Accessor methods
Methods used to get or set properties.
const char *	getName () const
	It returns the operator name.

void	setName (const char *opName)
	It sets the operator name.

Protected Attributes
Not Allowed Methods
No copy allowed.
const char *	m_name
	Operator name.

Accessor methods
Methods used to get or set properties.
PropertyName *	m_property
	A geometric property. (Mandatory)

te::gm::Geometry *	m_geom
	A literal geometric value. (It must be omitted if m_envelope is given)

te::gml::Envelope *	m_box
	A convenient and more compact way of encoding the very common bounding box constraint. (It must be omitted ig m_box is given)

void	setProperty (PropertyName *p)
	It sets the property name.

PropertyName *	getProperty () const
	It returns the property name.

void	setGeometry (te::gm::Geometry *g)
	It sets the geometry.

te::gm::Geometry *	getGeometry () const
	It returns the geometry.

void	setEnvelope (te::gml::Envelope *e)
	It sets the envelope.

te::gml::Envelope *	getEnvelope () const
	It returns the envelope.

AbstractOp *	clone () const
	It creates a new copy of this object.

Detailed Description

A class for binary spatial operators.

Binary spatial operators are used to test whether the value of a geometric property, referenced using the name of the property, and a literal geometric value satisfy the spatial relationship implied by the operator.
The following operators are defined in the Filter Encoding specification:

See also: SpatialOp, PropertyName

Definition at line 68 of file BinarySpatialOp.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

◆ BinarySpatialOp() [1/3]

te::fe::BinarySpatialOp::BinarySpatialOp ( const char * opName = 0 )

It initializes the BinarySpatialOp.

Parameters

opName The operator name.

Note: The BinarySpatialOp will not take the ownership of the given name.

Referenced by te::fe::Contains::Contains(), te::fe::Contains::Contains(), te::fe::Crosses::Crosses(), te::fe::Crosses::Crosses(), te::fe::Disjoint::Disjoint(), te::fe::Disjoint::Disjoint(), te::fe::Equals::Equals(), te::fe::Equals::Equals(), te::fe::Intersects::Intersects(), te::fe::Intersects::Intersects(), te::fe::Overlaps::Overlaps(), te::fe::Overlaps::Overlaps(), te::fe::Touches::Touches(), te::fe::Touches::Touches(), te::fe::Within::Within(), and te::fe::Within::Within().

◆ BinarySpatialOp() [2/3]

te::fe::BinarySpatialOp::BinarySpatialOp	(	const char *	opName,
		PropertyName *	p,
		te::gm::Geometry *	g )

It initializes the BinarySpatialOp.

Parameters

opName	The operator name.
p	The property name.
g	The geometry value.

Note: The BinarySpatialOp will not take the ownership of the given name.; The BinarySpatialOp will take the ownership of the given operands.

◆ BinarySpatialOp() [3/3]

te::fe::BinarySpatialOp::BinarySpatialOp	(	const char *	opName,
		PropertyName *	p,
		te::gml::Envelope *	e )

It initializes the BinarySpatialOp.

Parameters

opName	The operator name.
p	The property name.
e	The envelope value.

Note: The BinarySpatialOp will not take the ownership of the given name.; The BinarySpatialOp will take the ownership of the given operands.

◆ ~BinarySpatialOp()

virtual te::fe::BinarySpatialOp::~BinarySpatialOp ( )

virtual

Destructor.

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.

◆ clone()

AbstractOp * te::fe::BinarySpatialOp::clone ( ) const

virtual

It creates a new copy of this object.

Implements te::fe::AbstractOp.

◆ getEnvelope()

te::gml::Envelope * te::fe::BinarySpatialOp::getEnvelope ( ) const

It returns the envelope.

Returns: The envelope.

◆ getGeometry()

te::gm::Geometry * te::fe::BinarySpatialOp::getGeometry ( ) const

It returns the geometry.

Returns: The geometry.

◆ getName()

const char * te::fe::AbstractOp::getName ( ) const

inlineinherited

It returns the operator name.

Returns: The operator name.

Definition at line 82 of file AbstractOp.h.

References m_name.

◆ getProperty()

PropertyName * te::fe::BinarySpatialOp::getProperty ( ) const

It returns the property name.

Returns: The property name.

◆ setEnvelope()

void te::fe::BinarySpatialOp::setEnvelope ( te::gml::Envelope * e )

It sets the envelope.

Parameters

e	The envelope.

Note: It will take the ownership of the envelope.

◆ setGeometry()

void te::fe::BinarySpatialOp::setGeometry ( te::gm::Geometry * g )

It sets the geometry.

Parameters

g	The geometry.

Note: It will take the ownership of the geometry.

◆ setName()

void te::fe::AbstractOp::setName ( const char * opName )

inlineinherited

It sets the operator name.

Parameters

opName The operator name.

Definition at line 89 of file AbstractOp.h.

References m_name.

◆ setProperty()

void te::fe::BinarySpatialOp::setProperty ( PropertyName * p )

It sets the property name.

Parameters

p	The property name.

Note: It will take the ownership of the property name.

Member Data Documentation

◆ m_box

te::gml::Envelope* te::fe::BinarySpatialOp::m_box

protected

A convenient and more compact way of encoding the very common bounding box constraint. (It must be omitted ig m_box is given)

Definition at line 181 of file BinarySpatialOp.h.

◆ m_geom

te::gm::Geometry* te::fe::BinarySpatialOp::m_geom

protected

A literal geometric value. (It must be omitted if m_envelope is given)

Definition at line 180 of file BinarySpatialOp.h.

◆ m_name

const char* te::fe::AbstractOp::m_name

protectedinherited

Operator name.

Definition at line 123 of file AbstractOp.h.

Referenced by getName(), and setName().

◆ m_property

PropertyName* te::fe::BinarySpatialOp::m_property

protected

A geometric property. (Mandatory)

Definition at line 179 of file BinarySpatialOp.h.

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

/home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/fe/BinarySpatialOp.h

Public Types

Public Member Functions

Protected Attributes

Accessor methods

Detailed Description

Member Typedef Documentation

◆ ReturnType

◆ VisitorType

Constructor & Destructor Documentation

◆ BinarySpatialOp() [1/3]

◆ BinarySpatialOp() [2/3]

◆ BinarySpatialOp() [3/3]

◆ ~BinarySpatialOp()

Member Function Documentation

◆ accept()

◆ clone()

◆ getEnvelope()

◆ getGeometry()

◆ getName()

◆ getProperty()

◆ setEnvelope()

◆ setGeometry()

◆ setName()

◆ setProperty()

Member Data Documentation

◆ m_box

◆ m_geom

◆ m_name

◆ m_property