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

A class for scalar operations. More...

#include <FFaOperation.H>

Inheritance diagram for FFaUnaryOp< RetType, PrmType >:
Inheritance graph
[legend]
Collaboration diagram for FFaUnaryOp< RetType, PrmType >:
Collaboration graph
[legend]

Public Member Functions

 FFaUnaryOp (FFaOperation< PrmType > *param, const std::string &name="")
 The constructor selects the actual operation to use from name. More...
 
virtual void invalidate ()
 Invalidates the cached value of this operation. More...
 
virtual bool hasData () const
 Checks if this operation will return any data. More...
 
virtual bool evaluate (RetType &value)
 Invokes the actual operation. More...
 
- Public Member Functions inherited from FFaOperation< RetType >
bool invoke (RetType &value)
 Returns current value of this 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

virtual ~FFaUnaryOp ()
 The destructor deletes the child operation, if any. More...
 
- Protected Member Functions inherited from FFaOperation< RetType >
 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 Member Functions inherited from FFaOperationContainer< FFaDynCB2< RetType &, const RetType & > >
 FFaOperationContainer ()
 The default constructor defines the default operation. More...
 
void selectOperation (const std::string &name)
 Selects the named operation to use. More...
 

Private Attributes

FFaOperation< PrmType > * myParam
 Parameter child operation. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from FFaOperationBase
static void freeMemPools ()
 Dummy method doing nothing. More...
 
- Static Public Member Functions inherited from FFaOperationContainer< FFaDynCB2< RetType &, const RetType & > >
static void addOperation (const std::string &name, FFaDynCB2< RetType &, const RetType & > operation)
 Adds a named operation to the OperationCB container. More...
 
static void getOperations (std::vector< std::string > &names)
 Returns a list of all operations of type OperationCB. More...
 
static void setDefaultOperation (const std::string &o)
 Defines the default operation of type OperationCB. More...
 
static const std::string & getDefaultOperation ()
 Returns the default operation of type OperationCB. More...
 
- Protected Attributes inherited from FFaOperation< RetType >
bool IAmEvaluated
 If true, the cached value will be used. More...
 
- Protected Attributes inherited from FFaOperationContainer< FFaDynCB2< RetType &, const RetType & > >
FFaDynCB2< RetType &, const RetType & > myOperationCB
 The selected operation. More...
 

Detailed Description

template<class RetType, class PrmType = RetType>
class FFaUnaryOp< RetType, PrmType >

A class for scalar operations.

Constructor & Destructor Documentation

◆ FFaUnaryOp()

template<class RetType , class PrmType = RetType>
FFaUnaryOp< RetType, PrmType >::FFaUnaryOp ( FFaOperation< PrmType > *  param,
const std::string &  name = "" 
)
inline

The constructor selects the actual operation to use from name.

◆ ~FFaUnaryOp()

template<class RetType , class PrmType = RetType>
virtual FFaUnaryOp< RetType, PrmType >::~FFaUnaryOp ( )
inlineprotectedvirtual

The destructor deletes the child operation, if any.

Member Function Documentation

◆ evaluate()

template<class RetType , class PrmType = RetType>
virtual bool FFaUnaryOp< RetType, PrmType >::evaluate ( RetType &  value)
inlinevirtual

Invokes the actual operation.

Implements FFaOperation< RetType >.

◆ hasData()

template<class RetType , class PrmType = RetType>
virtual bool FFaUnaryOp< RetType, PrmType >::hasData ( ) const
inlinevirtual

Checks if this operation will return any data.

Implements FFaOperation< RetType >.

◆ invalidate()

template<class RetType , class PrmType = RetType>
virtual void FFaUnaryOp< RetType, PrmType >::invalidate ( )
inlinevirtual

Invalidates the cached value of this operation.

Reimplemented from FFaOperation< RetType >.

Member Data Documentation

◆ myParam

template<class RetType , class PrmType = RetType>
FFaOperation<PrmType>* FFaUnaryOp< RetType, PrmType >::myParam
private

Parameter child operation.


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