te::da::BinaryFunction Class Referenceabstract

A base class for binary functions. More...

#include <BinaryFunction.h>

Inheritance diagram for te::da::BinaryFunction:
te::da::Function te::da::Expression te::common::BaseVisitable< QueryVisitor > te::da::BinaryOp te::da::Cast te::da::Coalesce te::da::ST_Contains te::da::ST_Crosses te::da::ST_Difference te::da::ST_Disjoint te::da::ST_EnvelopeIntersects te::da::ST_Equals te::da::ST_Intersection te::da::ST_Intersects te::da::ST_Overlaps te::da::ST_SetSRID te::da::ST_Touches te::da::ST_Within

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...
 
TE_DEFINE_VISITABLE BinaryFunction (const std::string &name, Expression *arg1, Expression *arg2)
 Constructor. More...
 
 BinaryFunction (const std::string &name, const Expression &arg1, const Expression &arg2)
 Constructor. More...
 
 BinaryFunction (const BinaryFunction &rhs)
 Copy constructor. 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...
 
ExpressiongetFirst () const
 It returns the first 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...
 
ExpressiongetSecond () const
 It returns the second function argument. More...
 
BinaryFunctionoperator= (const BinaryFunction &rhs)
 
Expressionoperator[] (std::size_t i) const
 It returns the i-th function argument. More...
 
void setFirst (Expression *arg)
 It sets the first function argument. More...
 
void setSecond (Expression *arg)
 It sets the second function argument. More...
 
virtual ~BinaryFunction ()
 Virtual 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

A base class for binary functions.

See also
Function, BinaryOp

Definition at line 43 of file BinaryFunction.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::BinaryFunction::BinaryFunction ( const std::string &  name,
Expression arg1,
Expression arg2 
)

Constructor.

Parameters
nameThe function name.
arg1The first argument.
arg2The second argument.
Note
The BinaryFunction will take the ownership of the given arguments.
te::da::BinaryFunction::BinaryFunction ( const std::string &  name,
const Expression arg1,
const Expression arg2 
)

Constructor.

Parameters
nameThe function name.
arg1The first argument.
arg2The second argument.
te::da::BinaryFunction::BinaryFunction ( const BinaryFunction rhs)

Copy constructor.

virtual te::da::BinaryFunction::~BinaryFunction ( )
virtual

Virtual Destructor.

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::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.
Expression* te::da::BinaryFunction::getFirst ( ) const

It returns the first function argument.

Returns
The first 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.
Expression* te::da::BinaryFunction::getSecond ( ) const

It returns the second function argument.

Returns
The second function argument.
BinaryFunction& te::da::BinaryFunction::operator= ( const BinaryFunction 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.
void te::da::BinaryFunction::setFirst ( Expression arg)

It sets the first function argument.

Parameters
argThe first function argument.
Note
The BinaryFunction will take the ownership of the given argument.
void te::da::BinaryFunction::setSecond ( Expression arg)

It sets the second function argument.

Parameters
argThe second function argument.
Note
The BinaryFunction will take the ownership of the given 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: