te::fe::Function Class Reference

A function is a named procedure that performs a distinct computation. More...

#include <Function.h>

Inheritance diagram for te::fe::Function:

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.
	Function (const std::string &name)
	It initializes a new Function. More...
	~Function ()
	Destructor. More...
Accessor methods
Methods used to get or set properties.
const std::string &	getName () const
	It returns the function name. More...
void	setName (const std::string &n)
	It sets the function name. More...
Expression *	getArgument (size_t i) const
	It returns the argument in the specified position. More...
void	add (Expression *argument)
	It adds a new argument to the function. More...
void	setArgument (size_t i, Expression *argument)
	It sets the argument in the specified position. More...
void	removeArgument (size_t i)
	It removes the n-th argument. More...

Expression Re-implementation
Methods re-implemented from Expression.
std::string	m_name
	Function name. (Mandatory) More...
std::vector< Expression * >	m_argumentList
	Argument list (actually, a list of expressions). (Optional) More...
virtual Expression *	clone () const
	It returns a clone of this object. More...

Detailed Description

A function is a named procedure that performs a distinct computation.

A function may accept zero or more arguments as input and generates a single result.

See also

Expression

Definition at line 54 of file Function.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

Function()

te::fe::Function::Function

(

const std::string &

name

)

It initializes a new Function.

Parameters

name	Function name. Must be a non-empty value.

~Function()

te::fe::Function::~Function

(

)

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

guest

The guest or visitor.

Returns

Any valid value define by the template type R.

add()

void te::fe::Function::add

(

Expression *

argument

)

It adds a new argument to the function.

Parameters

argument

The argument to be added. The Function object will take the ownership of the given argument.

clone()

virtual Expression * te::fe::Function::clone ( ) const

virtual

It returns a clone of this object.

Returns

A clone of this object.

Implements te::fe::Expression.

getArgument()

Expression * te::fe::Function::getArgument

(

size_t

i

)

const

It returns the argument in the specified position.

Parameters

i	The argument index.

Returns

The argument in the specified position.

Note

The argument index start at 0.

It doesn't check the index range.

getName()

const std::string & te::fe::Function::getName

(

)

const

It returns the function name.

Returns

The function name.

removeArgument()

void te::fe::Function::removeArgument

(

size_t

i

)

It removes the n-th argument.

Parameters

i	The argument index.

Note

It doesn't check the index range.

setArgument()

void te::fe::Function::setArgument	(	size_t	i,
		Expression *	argument
	)

It sets the argument in the specified position.

Parameters

i	The argument index.
argument	The new argument. The Function object will take the ownership of the given argument.

Note

The argument index start at 0.

Be sure that the argument list is already defined having the location you are specifying.

It doesn't check the index range.

setName()

void te::fe::Function::setName

(

const std::string &

n

)

It sets the function name.

Parameters

n	The function name.

Member Data Documentation

m_argumentList

std::vector<Expression*> te::fe::Function::m_argumentList

protected

Argument list (actually, a list of expressions). (Optional)

Definition at line 154 of file Function.h.

m_name

std::string te::fe::Function::m_name

protected

Function name. (Mandatory)

Definition at line 153 of file Function.h.

---

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

• /home/castejon/castejon_files/develop/terralib5/git_release/src/terralib/fe/Function.h