te::da::ST_Relate Class Referenceabstract

Spatial relation function. More...

#include <ST_Relate.h>

Inheritance diagram for te::da::ST_Relate:
te::da::Function te::da::Expression te::common::BaseVisitable< QueryVisitor >

Public Types

typedef void ReturnType
 
typedef QueryVisitor VisitorType
 

Public Member Functions

virtual ReturnType accept (VisitorType &guest) const =0
 It call the visit method from the guest object. More...
 
void add (Expression *arg)
 It adds the argument to the function list of arguments. More...
 
Expressionclone () const
 It creates a new copy of this expression. More...
 
ExpressiongetArg (std::size_t i) const
 It returns the i-th function argument. More...
 
const std::string & getName () const
 It returns the function name. More...
 
std::size_t getNumArgs () const
 It returns the number of arguments informed to the function. More...
 
ST_Relateoperator= (const ST_Relate &rhs)
 
Expressionoperator[] (std::size_t i) const
 It returns the i-th function argument. More...
 
TE_DEFINE_VISITABLE ST_Relate (Expression *g1, Expression *g2, LiteralString *intersectionMatrix=0)
 Constructor. More...
 
 ST_Relate (const Expression &g1, const Expression &g2, const std::string &intersectionMatrix=std::string(""))
 Constructor. More...
 
 ST_Relate (const ST_Relate &rhs)
 Copy constructor. More...
 
 ~ST_Relate ()
 Destructor. More...
 

Protected Attributes

std::vector< Expression * > m_args
 The list of arguments. More...
 
std::string m_name
 The function name. May be an operator symbol or just a regular name like ST_Intersects. More...
 

Detailed Description

Spatial relation function.

This function is just a syntatic-suggar.

See also
Function

Definition at line 48 of file ST_Relate.h.

Member Typedef Documentation

typedef void te::common::BaseVisitable< QueryVisitor , void >::ReturnType
inherited

Definition at line 58 of file BaseVisitable.h.

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

TE_DEFINE_VISITABLE te::da::ST_Relate::ST_Relate ( Expression g1,
Expression g2,
LiteralString intersectionMatrix = 0 
)

Constructor.

Parameters
g1The first geometric argument.
g2The second geometric argument.
intersectionMatrixA intersection matrix.
Note
The third parameter is optional. If omitted the function result is a intersection matrix otherwise the result is a boolean.
The operator will take the ownership of the given arguments.
te::da::ST_Relate::ST_Relate ( const Expression g1,
const Expression g2,
const std::string &  intersectionMatrix = std::string("") 
)

Constructor.

Parameters
g1The first geometric argument.
g2The second geometric argument.
intersectionMatrixA intersection matrix.
Note
The third parameter is optional. If omitted the function result is a intersection matrix otherwise the result is a boolean.
te::da::ST_Relate::ST_Relate ( const ST_Relate rhs)

Copy constructor.

te::da::ST_Relate::~ST_Relate ( )
inline

Destructor.

Definition at line 82 of file ST_Relate.h.

Member Function Documentation

virtual ReturnType te::common::BaseVisitable< QueryVisitor , 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.
void te::da::Function::add ( Expression arg)
inherited

It adds the argument to the function list of arguments.

Parameters
argThe argument to be added.
Note
The Function will take the ownership of the given argument.
Expression* te::da::ST_Relate::clone ( ) const
virtual

It creates a new copy of this expression.

Reimplemented from te::da::Function.

Expression* te::da::Function::getArg ( std::size_t  i) const
inherited

It returns the i-th function argument.

Parameters
iThe argument position.
Returns
The it-th function argument.
const std::string& te::da::Function::getName ( ) const
inlineinherited

It returns the function name.

Returns
The function name.

Definition at line 79 of file Function.h.

std::size_t te::da::Function::getNumArgs ( ) const
inherited

It returns the number of arguments informed to the function.

Returns
The number of parameters.
ST_Relate& te::da::ST_Relate::operator= ( const ST_Relate rhs)

Assignment operator.

Expression* te::da::Function::operator[] ( std::size_t  i) const
inherited

It returns the i-th function argument.

Parameters
iThe argument position.
Returns
The it-th function argument.

Member Data Documentation

std::vector<Expression*> te::da::Function::m_args
protectedinherited

The list of arguments.

Definition at line 118 of file Function.h.

std::string te::da::Function::m_name
protectedinherited

The function name. May be an operator symbol or just a regular name like ST_Intersects.

Definition at line 117 of file Function.h.


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