te::fe::SpatialOperator Class Reference

Spatial operator. More...

#include <SpatialOperator.h>

Public Member Functions

Initializer Methods

Methods related to instantiation and destruction.

 SpatialOperator (const char *opName)
 It initializes a new SpatialOperator. More...
 
 ~SpatialOperator ()
 Destructor. More...
 

Private Attributes

GeometryOperandsm_geometryOperands
 Optional. More...
 
const char * m_name
 Spatial operator name. More...
 

Static Private Attributes

static std::set< const char *, te::common::LessCmp< const char * > > sm_validSpatialOperators
 The list of valid spatial operators. More...
 

Accessor methods

Methods used to get or set properties.

const char * getOpName () const
 It returns the operator name. More...
 
void setGeometryOperands (GeometryOperands *gOps)
 It sets the geometry operands. More...
 
const GeometryOperandsgetGeometryOperands () const
 It returns the geometry operands. More...
 
static const char * findOperator (const char *o)
 It checks if operator 'o' is a valid operator. It returns a pointer to the found operator or NULL otherwise. More...
 
static void loadValidOperatorList ()
 It loads the valid spatial operator list. More...
 
static void clearValidOperatorList ()
 It clears the valid operator list. More...
 

Detailed Description

Spatial operator.

Spatial operator name can be one of the following names:

See also
SpatialOperators, GeometryOperands

Definition at line 67 of file SpatialOperator.h.

Constructor & Destructor Documentation

◆ SpatialOperator()

te::fe::SpatialOperator::SpatialOperator ( const char *  opName)

It initializes a new SpatialOperator.

Parameters
Thespatial operator name.
Note
The opName must be a value from the list of valid spatial operators.

◆ ~SpatialOperator()

te::fe::SpatialOperator::~SpatialOperator ( )

Destructor.

Member Function Documentation

◆ clearValidOperatorList()

static void te::fe::SpatialOperator::clearValidOperatorList ( )
static

It clears the valid operator list.

◆ findOperator()

static const char* te::fe::SpatialOperator::findOperator ( const char *  o)
static

It checks if operator 'o' is a valid operator. It returns a pointer to the found operator or NULL otherwise.

Parameters
oThe operator name we are looking for.

◆ getGeometryOperands()

const GeometryOperands* te::fe::SpatialOperator::getGeometryOperands ( ) const

It returns the geometry operands.

Returns
The geometry operands.

◆ getOpName()

const char* te::fe::SpatialOperator::getOpName ( ) const

It returns the operator name.

Returns
The operator name.

◆ loadValidOperatorList()

static void te::fe::SpatialOperator::loadValidOperatorList ( )
static

It loads the valid spatial operator list.

◆ setGeometryOperands()

void te::fe::SpatialOperator::setGeometryOperands ( GeometryOperands gOps)

It sets the geometry operands.

Parameters
gOpsThe geometry operands.
Note
It will take the ownership of the geometry operands. So, don't release the geometry operands resources.

Member Data Documentation

◆ m_geometryOperands

GeometryOperands* te::fe::SpatialOperator::m_geometryOperands
private

Optional.

Definition at line 138 of file SpatialOperator.h.

◆ m_name

const char* te::fe::SpatialOperator::m_name
private

Spatial operator name.

Definition at line 137 of file SpatialOperator.h.

◆ sm_validSpatialOperators

std::set<const char*, te::common::LessCmp<const char*> > te::fe::SpatialOperator::sm_validSpatialOperators
staticprivate

The list of valid spatial operators.

Definition at line 140 of file SpatialOperator.h.


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