FEDEM Solver  R8.0
Source code of the dynamics solver
Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
FFaOperation< RetType > Class Template Referenceabstract

The base class used as argument in other operations. More...

#include <FFaOperation.H>

Inheritance diagram for FFaOperation< RetType >:
Inheritance graph
[legend]
Collaboration diagram for FFaOperation< RetType >:
Collaboration graph
[legend]

Public Member Functions

bool invoke (RetType &value)
 Returns current value of this operation. More...
 
virtual void invalidate ()
 Invalidates the cached value of this operation. More...
 
virtual bool hasData () const =0
 Checks if this operation will return any data. More...
 
virtual bool evaluate (RetType &value)=0
 Invokes the actual operation. More...
 
- Public Member Functions inherited from FFaOperationBase
void ref ()
 Increments the reference counter. More...
 
void unref ()
 Decrements the reference counter, and deletes *this if zero. More...
 

Protected Member Functions

 FFaOperation ()
 Default constructor. More...
 
virtual ~FFaOperation ()
 Empty destructor. More...
 
- Protected Member Functions inherited from FFaOperationBase
 FFaOperationBase ()
 Default constructor. More...
 
virtual ~FFaOperationBase ()
 Empty destructor. More...
 

Protected Attributes

bool IAmEvaluated
 If true, the cached value will be used. More...
 

Private Attributes

RetType myCachedValue
 Cached operation value, to avoid re-evaluation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FFaOperationBase
static void freeMemPools ()
 Dummy method doing nothing. More...
 

Detailed Description

template<class RetType>
class FFaOperation< RetType >

The base class used as argument in other operations.

Constructor & Destructor Documentation

◆ FFaOperation()

template<class RetType >
FFaOperation< RetType >::FFaOperation ( )
inlineprotected

Default constructor.

◆ ~FFaOperation()

template<class RetType >
virtual FFaOperation< RetType >::~FFaOperation ( )
inlineprotectedvirtual

Empty destructor.

Member Function Documentation

◆ evaluate()

template<class RetType >
virtual bool FFaOperation< RetType >::evaluate ( RetType &  value)
pure virtual

Invokes the actual operation.

Implemented in FFrReadOp< RetType >, FFaNToOneOp< RetType >, and FFaUnaryOp< RetType, PrmType >.

◆ hasData()

template<class RetType >
virtual bool FFaOperation< RetType >::hasData ( ) const
pure virtual

Checks if this operation will return any data.

Implemented in FFrReadOp< RetType >, FFaNToOneOp< RetType >, and FFaUnaryOp< RetType, PrmType >.

◆ invalidate()

template<class RetType >
virtual void FFaOperation< RetType >::invalidate ( )
inlinevirtual

Invalidates the cached value of this operation.

Reimplemented in FFaNToOneOp< RetType >, and FFaUnaryOp< RetType, PrmType >.

◆ invoke()

template<class RetType >
bool FFaOperation< RetType >::invoke ( RetType &  value)
inline

Returns current value of this operation.

Member Data Documentation

◆ IAmEvaluated

template<class RetType >
bool FFaOperation< RetType >::IAmEvaluated
protected

If true, the cached value will be used.

◆ myCachedValue

template<class RetType >
RetType FFaOperation< RetType >::myCachedValue
private

Cached operation value, to avoid re-evaluation.


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