This is a partial specialization of Parameter for the string case. More...
#include <Parameter.h>
Inheritance diagram for ThePEG::Parameter< T, string >:
Public Types | |
| typedef void(T::* | SetFn )(string) |
| The declaration of member functions which can be used by this Switch interface for the 'set' action. | |
| typedef string(T::* | GetFn )() const |
| The declaration of member functions which can be used by this Switch interface for the 'get', 'def', 'min' and 'max' actions. | |
| typedef string T::* | Member |
| Declaration of a direct pointer to the member variable. | |
 Public Types inherited from ThePEG::ParameterTBase< string > | |
| enum | FileType { NoFile, File, Directory } |
| Enumerated variables to determine of a string parameter corresponds to a file or a directory. More... | |
Public Member Functions | |
| Parameter (string newName, string newDescription, Member newMember, string newDef, bool depSafe=false, bool readonly=false, SetFn newSetFn=0, GetFn newGetFn=0, GetFn newDefFn=0) | |
| Standard constructor. | |
| virtual | ~Parameter () |
| Default dtor. | |
| virtual void | tset (InterfacedBase &ib, string val) const |
| Set the member variable of ib to val. | |
| virtual string | tget (const InterfacedBase &ib) const |
| Return the value of the member variable of ib. | |
| virtual string | 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(). | |
| virtual void | doxygenDescription (ostream &stream) const |
| Print a description to be included in the Doxygen documentation to the given stream. | |
| Public Member Functions inherited from ThePEG::ParameterTBase< string > | |
| ParameterTBase (string newName, string newDescription, string newClassName, const type_info &newTypeInfo, bool depSafe, bool readonly) | |
| Standard constructor. | |
| virtual | ~ParameterTBase () |
| Destructor. | |
| virtual string | type () const |
| Return a code for the type of this parameter. | |
| void | fileType () |
| Indicate that this parameter corresponds to a file. | |
| void | directoryType () |
| Indicate that this parameter corresponds to a directory. | |
| void | file (FileType t) |
| Indicate if this parameter corresponds to a file or directory. | |
| FileType | file () const |
| See if this parameter corresponds to a file or directory. | |
| 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 &) const |
| Return the minimum value allowed for the member variable of ib. | |
| virtual string | maximum (const InterfacedBase &) 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 &i) const |
| set the member variable of ib to its default value. | |
| virtual string | doxygenType () const |
| Return a string describing the type of interface to be included in the Doxygen documentation. | |
| Public Member Functions inherited from ThePEG::ParameterBase | |
| 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. | |
| Public Member Functions inherited from ThePEG::InterfaceBase | |
| 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. | |
| Public Member Functions inherited from ThePEG::Named | |
| 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. | |
Private Attributes | |
| Member | theMember |
| The pointer to the member variable. | |
| string | theDef |
| Default, minimum and maximum values to be used if no corresponding member function pointers are given. | |
| SetFn | theSetFn |
| A pointer to a member function to be used by tset(). | |
| GetFn | theGetFn |
| Pointer to member function to be used by tget(). | |
| GetFn | theDefFn |
| Pointer to member function to be used by tdef(). | |
Detailed Description
template<typename T>
class ThePEG::Parameter< T, string >
This is a partial specialization of Parameter for the string case.
- See also:
- Parameter
Definition at line 963 of file Parameter.h.
Constructor & Destructor Documentation
template<typename T >
|
inline |
Standard constructor.
- Parameters:
-
newName the name of the interface, may only contain letters [a-zA-z0-9_]. newDescription a brief description of the interface. newMember a pointer to the member variable. May be null if corresponding set/get functions are provided. newDef the default value for the member variable. depSafe set to true if calls to this interface for one object does not influence other objects. readonly if this is set true the interface will not be able to manipulate objects of the corresponding class, but will still be able to access information. newSetFn optional pointer to the member function for the 'set' action. newGetFn optional pointer to the member function for the 'get' action. newDefFn optional pointer to the member function for the 'def' action.
Definition at line 1014 of file Parameter.h.
The documentation for this class was generated from the following file:
