te::fe::BinarySpatialOp Class Referenceabstract

A class for binary spatial operators. More...

#include <BinarySpatialOp.h>

Inheritance diagram for te::fe::BinarySpatialOp:
te::fe::SpatialOp te::fe::AbstractOp te::common::BaseVisitable< Visitor > te::fe::Contains te::fe::Crosses te::fe::Disjoint te::fe::Equals te::fe::Intersects te::fe::Overlaps te::fe::Touches te::fe::Within

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...
 
PropertyNamegetProperty () const
 It returns the property name. More...
 
void setGeometry (te::gm::Geometry *g)
 It sets the geometry. More...
 
te::gm::GeometrygetGeometry () const
 It returns the geometry. More...
 
void setEnvelope (te::gml::Envelope *e)
 It sets the envelope. More...
 
te::gml::EnvelopegetEnvelope () const
 It returns the envelope. More...
 
AbstractOpclone () const
 It creates a new copy of this object. 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::Envelopem_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::Geometrym_geom
 A literal geometric value. (It must be omitted if m_envelope is given) More...
 
const char * m_name
 Operator name. More...
 
PropertyNamem_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

◆ 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
opNameThe operator name.
Note
The BinarySpatialOp will not take the ownership of the given name.

◆ BinarySpatialOp() [2/3]

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

It initializes the BinarySpatialOp.

Parameters
opNameThe operator name.
pThe property name.
gThe 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
opNameThe operator name.
pThe property name.
eThe 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
guestThe 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.

◆ 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
eThe 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
gThe 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
opNameThe operator name.

Definition at line 89 of file AbstractOp.h.

◆ setProperty()

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

It sets the property name.

Parameters
pThe 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.

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