LOCA::Parameter::StandardEntry< FunctorType, ValueType > Class Template Reference

Standard parameter entry class using a function object. More...

#include <LOCA_Parameter_Entry.H>

Inheritance diagram for LOCA::Parameter::StandardEntry< FunctorType, ValueType >:

[legend]
Collaboration diagram for LOCA::Parameter::StandardEntry< FunctorType, ValueType >:
[legend]
List of all members.

Public Member Functions

 StandardEntry (FunctorType *fctr)
 Constructor.
virtual ~StandardEntry ()
 Destructor.
virtual void setValue (const ValueType &value)
 Set parameter this object represents to value.
virtual ValueType getValue () const
 Get parameter value this object represents.
virtual void setIsInLibrary ()
 Informs entry that it is now stored in the library.

Protected Attributes

bool deleteFctr
 Flag indicating whether to delete function object in destructor.
FunctorType * func
 Stores pointer to function object.

Detailed Description

template<class FunctorType, class ValueType>
class LOCA::Parameter::StandardEntry< FunctorType, ValueType >

Standard parameter entry class using a function object.

This is the standard parameter entry class that uses a function object to actually set/retrieve parameter values. The nice thing about using a function object is it allows one to set parameters that don't actually exist in the code, for example, setting a dimensionless group value by modifiying a number of physical parameters. By supplying an appropriate function object, this class should suffice for setting/retrieving parameter values in nearly all cases.

The constructor takes a pointer to the supplied function object. It is assumed that this class then owns that pointer, and in particular, calls delete in the destructor if the entry is successfully added to the library. It does not delete the function object otherwise.


Member Function Documentation

template<class FunctorType, class ValueType>
virtual void LOCA::Parameter::StandardEntry< FunctorType, ValueType >::setIsInLibrary  )  [inline, virtual]
 

Informs entry that it is now stored in the library.

This is used primarily for informing the entry on how to delete itself when deleting the library.

Implements LOCA::Parameter::Entry< ValueType >.


The documentation for this class was generated from the following file:
Generated on Thu Sep 18 12:40:47 2008 for NOX by doxygen 1.3.9.1