te::da::UnaryFunction Class Reference

A base class for unary functions. More...

#include <UnaryFunction.h>

Inheritance diagram for te::da::UnaryFunction:

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.
void	add (Expression *arg)
	It adds the argument to the function list of arguments.
Expression *	clone () const
	It creates a new copy of this expression.
Expression *	getArg (std::size_t i) const
	It returns the i-th function argument.
Expression *	getArgument () const
	It returns the function associated argument.
const std::string &	getName () const
	It returns the function name.
std::size_t	getNumArgs () const
	It returns the number of arguments informed to the function.
UnaryFunction &	operator= (const UnaryFunction &rhs)
Expression *	operator[] (std::size_t i) const
	It returns the i-th function argument.
void	setArgument (Expression *arg)
	It sets the function argument.
	UnaryFunction (const std::string &name, const Expression &arg)
	Constructor.
TE_DEFINE_VISITABLE	UnaryFunction (const std::string &name, Expression *arg)
	Constructor.
	UnaryFunction (const UnaryFunction &rhs)
	Copy constructor.
virtual	~UnaryFunction ()
	Virtual Destructor.

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

Detailed Description

A base class for unary functions.

See also

Function, UnaryOp

Definition at line 43 of file UnaryFunction.h.

Member Typedef Documentation

ReturnType

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

inherited

Definition at line 58 of file BaseVisitable.h.

VisitorType

typedef QueryVisitor te::common::BaseVisitable< QueryVisitor, void >::VisitorType

inherited

Definition at line 57 of file BaseVisitable.h.

Constructor & Destructor Documentation

UnaryFunction() [1/3]

TE_DEFINE_VISITABLE te::da::UnaryFunction::UnaryFunction	(	const std::string &	name,
		Expression *	arg )

Constructor.

Parameters

name	The function name.
arg	The single function argument.

Note

The UnaryFunction will take the ownership of the given argument.

Referenced by te::da::Avg::Avg(), te::da::Avg::Avg(), te::da::Count::Count(), te::da::Count::Count(), te::da::IsNull::IsNull(), te::da::IsNull::IsNull(), te::da::Max::Max(), te::da::Max::Max(), te::da::Min::Min(), te::da::Min::Min(), operator=(), te::da::ST_Boundary::ST_Boundary(), te::da::ST_Boundary::ST_Boundary(), te::da::ST_Collect::ST_Collect(), te::da::ST_Collect::ST_Collect(), te::da::ST_Dump::ST_Dump(), te::da::ST_Dump::ST_Dump(), te::da::ST_DumpRings::ST_DumpRings(), te::da::ST_DumpRings::ST_DumpRings(), te::da::ST_MakePolygon::ST_MakePolygon(), te::da::ST_MakePolygon::ST_MakePolygon(), te::da::ST_NumGeometries::ST_NumGeometries(), te::da::ST_NumGeometries::ST_NumGeometries(), te::da::ST_Union::ST_Union(), te::da::ST_Union::ST_Union(), te::da::StdDev::StdDev(), te::da::StdDev::StdDev(), te::da::Sum::Sum(), te::da::Sum::Sum(), UnaryFunction(), te::da::UnaryOp::UnaryOp(), te::da::UnaryOp::UnaryOp(), te::da::Variance::Variance(), and te::da::Variance::Variance().

UnaryFunction() [2/3]

te::da::UnaryFunction::UnaryFunction	(	const std::string &	name,
		const Expression &	arg )

Constructor.

Parameters

name	The function name.
arg	The single function argument.

UnaryFunction() [3/3]

te::da::UnaryFunction::UnaryFunction

(

const UnaryFunction &

rhs

)

Copy constructor.

References UnaryFunction().

~UnaryFunction()

virtual te::da::UnaryFunction::~UnaryFunction ( )

virtual

Virtual Destructor.

Member Function Documentation

accept()

virtual ReturnType te::common::BaseVisitable< QueryVisitor, 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.

add()

void te::da::Function::add ( Expression * arg )

inherited

It adds the argument to the function list of arguments.

Parameters

arg	The argument to be added.

Note

The Function will take the ownership of the given argument.

References te::da::Expression::Expression().

clone()

Expression * te::da::UnaryFunction::clone ( ) const

virtual

It creates a new copy of this expression.

Reimplemented from te::da::Function.

Reimplemented in te::da::UnaryOp, and te::da::Variance.

getArg()

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

inherited

It returns the i-th function argument.

Parameters

i	The argument position.

Returns

The it-th function argument.

References te::da::Expression::Expression().

getArgument()

Expression * te::da::UnaryFunction::getArgument

(

)

const

It returns the function associated argument.

Returns

The function associated argument.

getName()

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.

References m_name.

getNumArgs()

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

inherited

It returns the number of arguments informed to the function.

Returns

The number of parameters.

operator=()

UnaryFunction & te::da::UnaryFunction::operator=

(

const UnaryFunction &

rhs

)

Assignment operator.

References UnaryFunction().

operator[]()

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

inherited

It returns the i-th function argument.

Parameters

i	The argument position.

Returns

The it-th function argument.

References te::da::Expression::Expression().

setArgument()

void te::da::UnaryFunction::setArgument

(

Expression *

arg

)

It sets the function argument.

Parameters

arg	The single function argument.

Note

The UnaryFunction will take the ownership of the given argument.

Member Data Documentation

m_args

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

protectedinherited

The list of arguments.

Definition at line 118 of file Function.h.

m_name

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.

Referenced by Function(), and getName().

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/dataaccess/query/UnaryFunction.h