Public Member Functions |
| Parameter (string newName, string newDescription, Member newMember, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, bool limits=true, SetFn newSetFn=0, GetFn newGetFn=0, GetFn newMinFn=0, GetFn newMaxFn=0, GetFn newDefFn=0) |
| Standard constructor.
|
| Parameter (string newName, string newDescription, Member newMember, Type newUnit, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, bool limits=true, SetFn newSetFn=0, GetFn newGetFn=0, GetFn newMinFn=0, GetFn newMaxFn=0, GetFn newDefFn=0) |
| Standard constructor.
|
| Parameter (string newName, string newDescription, Member newMember, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, int limits=Interface::limited, SetFn newSetFn=0, GetFn newGetFn=0, GetFn newMinFn=0, GetFn newMaxFn=0, GetFn newDefFn=0) |
| Standard constructor.
|
| Parameter (string newName, string newDescription, Member newMember, Type newUnit, Type newDef, Type newMin, Type newMax, bool depSafe=false, bool readonly=false, int limits=Interface::limited, SetFn newSetFn=0, GetFn newGetFn=0, GetFn newMinFn=0, GetFn newMaxFn=0, GetFn newDefFn=0) |
| Standard constructor.
|
virtual | ~Parameter () |
| Default dtor.
|
virtual void | tset (InterfacedBase &ib, Type val) const |
| Set the member variable of ib to val.
|
virtual Type | tget (const InterfacedBase &ib) const |
| Return the value of the member variable of ib.
|
virtual Type | tminimum (const InterfacedBase &ib) const |
| Return the minimum value allowed for the member variable of ib.
|
virtual Type | tmaximum (const InterfacedBase &ib) const |
| Return the miaximum value allowed for the member variable of ib.
|
virtual Type | tdef (const InterfacedBase &ib) const |
| Return the default value for the member variable of ib.
|
void | setSetFunction (SetFn sf) |
| Give a pointer to a member function to be used by tset().
|
void | setGetFunction (GetFn gf) |
| Give a pointer to a member function to be used by tget().
|
void | setDefaultFunction (GetFn df) |
| Give a pointer to a member function to be used by tdef().
|
void | setMinFunction (GetFn mf) |
| Give a pointer to a member function to be used by tminimum().
|
void | setMaxFunction (GetFn mf) |
| Give a pointer to a member function to be used by tmaximum().
|
virtual void | doxygenDescription (ostream &stream) const |
| Print a description to be included in the Doxygen documentation to the given stream.
|
| ParameterTBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, Type newUnit, bool depSafe, bool readonly, int limits) |
| Standard constructor.
|
virtual | ~ParameterTBase () |
| Destructor.
|
virtual string | type () const |
| Return a code for the type of this parameter.
|
virtual void | set (InterfacedBase &ib, string newValue) const |
| Set the member variables of ib to val.
|
virtual string | get (const InterfacedBase &ib) const |
| Return the value of the member variable of ib.
|
virtual string | minimum (const InterfacedBase &ib) const |
| Return the minimum value allowed for the member variable of ib.
|
virtual string | maximum (const InterfacedBase &ib) const |
| Return the maximum value allowed for the member variable of ib.
|
virtual string | def (const InterfacedBase &ib) const |
| Return the default value for the member variables of ib.
|
virtual void | setDef (InterfacedBase &ib) const |
| set the member variable of ib to its default value.
|
Type | unit () const |
| Get the unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double.
|
void | unit (Type u) |
| Set the unit which an Type object is divided (multiplied) by when written to (read from) a stream via a double.
|
virtual string | doxygenType () const |
| Return a string describing the type of interface to be included in the Doxygen documentation.
|
virtual | ~ParameterBase () |
| The destructor.
|
virtual string | exec (InterfacedBase &ib, string action, string arguments) const |
| The general interface method overriding the one in InterfaceBase.
|
virtual string | fullDescription (const InterfacedBase &ib) const |
| Return a complete description of this parameter.
|
bool | limited () const |
| True if there the variable is limited from above and below.
|
bool | upperLimit () const |
| True if there the variable is limited from abovew.
|
bool | lowerLimit () const |
| True if there the variable is limited from below.
|
void | setLimited () |
| Set flag indicating that there are limits associated with the variable.
|
void | setUnlimited () |
| Set flag indicating that there are no limits associated with the variable.
|
| InterfaceBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, bool depSafe, bool readonly) |
| Standard constructor.
|
virtual | ~InterfaceBase () |
| The destructor.
|
string | tag (int pos=-1) const |
| Create a tag for this interface using its name and optional poisitional argument.
|
virtual bool | notDefault (InterfacedBase &) const |
| Returns true if the setting for this interface has been changed from its default value.
|
map< string, string > & | objectDefaults (InterfacedBase &) const |
| Returns the map of objectDefaults of the given object.
|
virtual void | rebind (InterfacedBase &, const TranslationMap &, const IVector &=IVector()) const |
| Rebind all references in ib according to the translation map.
|
virtual IVector | getReferences (const InterfacedBase &) const |
| For derived classes interfacing references between Interfaced objects, return the references for this interface.
|
string | description () const |
| Return the description of this interface.
|
string | className () const |
| Return the class name for the class this interface is defined for.
|
bool | dependencySafe () const |
| Get the flag saying whether changing an object with this interface may change the state of a dependent object .
|
void | setDependencySafe () |
| Set the flag saying whether changing an object with this interface may change the state of a dependent object .
|
void | setDependencySensitive () |
| Set the flag saying whether changing an object with this interface may change the state of a dependent object .
|
bool | readOnly () const |
| Get the flag saying whether this interface is allowed to change an object.
|
void | setReadOnly () |
| Set the flag saying that this interface is allowed to change an object.
|
void | setReadWrite () |
| Unset the flag saying that this interface is allowed to change an object.
|
bool | anonymous () const |
| Return true if this interface is anonyous, ie.
|
double | rank () const |
| Get the rank for this interface.
|
void | rank (double r) |
| Set the rank for this interface.
|
void | setHasDefault (bool b) |
| Indicate that this interface has a default value.
|
| Named (const string &newName=string()) |
| Constructor with name.
|
const string & | name () const |
| Return name.
|
bool | operator== (const Named &other) const |
| Test for equality.
|
bool | operator< (const Named &other) const |
| Lexicographical comparison.
|
template<typename T, typename Type>
class ThePEG::Parameter< T, Type >
The Parameter and its base classes ParameterTBase and ParameterBase defines an interface to a class derived from the InterfacedBase, through which simple member variables can be manuipulated.
Parameter is templated on the type of the member variable and the type of the InterfacedBase class, and is derived from the InterfaceBase class via ParameterTBase (which is templated only on the type of the member variable) and ParameterBase.
For each InterfacedBase class exactly one static Parameter object should created for each member variable which should be interfaced. This object will automatically register itself with the BaseRepository class.
- See also:
- InterfacedBase
-
InterfaceBase
Definition at line 418 of file Parameter.h.