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

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

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

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

virtual	~BinarySpatialOp ()
	Destructor. More...

Accessor methods
Methods used to get or set properties.
void	setProperty (PropertyName *p)
	It sets the property name. More...

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

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

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

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

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

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

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

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

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

const char *	m_name
	Operator name. More...

PropertyName *	m_property
	A geometric property. (Mandatory) More...

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

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

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.

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.

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

virtual

Destructor.

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.

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

It returns the envelope.

Returns: The envelope.

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

It returns the geometry.

Returns: The geometry.

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.

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

It returns the property name.

Returns: The property name.

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.

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.

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.

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

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

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 177 of file BinarySpatialOp.h.

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

protectedinherited

Operator name.

Definition at line 120 of file AbstractOp.h.

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

protected

A geometric property. (Mandatory)

Definition at line 176 of file BinarySpatialOp.h.

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

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation