C++ mpi module for stochmagnet_main Package
Public Member Functions | Protected Member Functions | List of all members
EXPR_Function Class Referenceabstract

This class described a function. More...

#include <EXPR_Function.h>

Inheritance diagram for EXPR_Function:
Inheritance graph
[legend]
Collaboration diagram for EXPR_Function:
Collaboration graph
[legend]

Public Member Functions

tString getName () const
 get the name of the function More...
 
virtual void apply (const std::vector< tString > &args, EXPR_Node &node) const =0
 apply the function to the environment More...
 
- Public Member Functions inherited from EXPR_Object
virtual tMemSize getMemorySize () const override
 return the memory size of the class More...
 
virtual tMemSize getContentsMemorySize () const override
 return nthe memory size of the included associations More...
 
- Public Member Functions inherited from CORE_Object
template<class T >
std::shared_ptr< T > getSharedPointer ()
 return the shared pointer for this More...
 
template<class T >
std::shared_ptr< const T > getConstSharedPointer () const
 return a const shared pointer for this More...
 
template<class T >
tBoolean isInstanceOf () const
 test if the clas T is an instance of this class More...
 
tString getClassName () const
 return the name of the class More...
 
tString getPointerString () const
 retrun the pointer of the class as a string More...
 
tString getIdentityString () const
 retrun the string identification of the class More...
 
virtual tString toString () const
 return the string representation of the object node More...
 

Protected Member Functions

 EXPR_Function ()
 create the class
 
virtual ~EXPR_Function ()
 delete the class
 
void setName (const tString &name)
 set the name of the function More...
 
- Protected Member Functions inherited from EXPR_Object
 EXPR_Object (void)
 create the class
 
virtual ~EXPR_Object (void)
 delete the class
 
- Protected Member Functions inherited from CORE_Object
 CORE_Object ()
 build an instance of the object
 
virtual ~CORE_Object ()
 destroy the instance of object std

 

Additional Inherited Members

- Static Public Member Functions inherited from CORE_Object
static tBoolean EnableMemoryStack (const tBoolean &isMemoryChecked)
 enable the memory stack More...
 
static void EnableMemoryStack ()
 enable the memory stack
 
static void DisableMemoryStack ()
 disable the memory stack
 
static tBoolean IsMemoryStackEnabled ()
 return trur if the memory stack is enabled
 
static tString MemoryStackToString ()
 get the memory stack in string More...
 
static tIndex GetRegisteredClassesNumber ()
 get the memory stack in string More...
 

Detailed Description

This class described a function.

Author
Stéphane Despréaux
Version
1.0

Member Function Documentation

◆ apply()

virtual void EXPR_Function::apply ( const std::vector< tString > &  args,
EXPR_Node node 
) const
pure virtual

apply the function to the environment

Parameters
[in]argsarguments of the function
[out]nodeapplying the function to node

Implemented in EXPR_TranslationFunction, EXPR_RotationFunction, EXPR_LinearFunction, and EXPR_AffineFunction.

◆ getName()

tString EXPR_Function::getName ( ) const
inline

get the name of the function

Returns
the name of the function

◆ setName()

void EXPR_Function::setName ( const tString &  name)
inlineprotected

set the name of the function

Parameters
[in]namename of the function

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