ThePEG::ThePEG::ParameterTBase< string > Class Template Reference
This is a specialization of ParameterTBase for the string case. More...
#include <Parameter.h>
Public Types | |
| enum | FileType { NoFile, File, Directory } |
| Enumerated variables to determine of a string parameter corresponds to a file or a directory. More... | |
Public Member Functions | |
| 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 void | tset (InterfacedBase &ib, string) const =0 |
| 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 | tget (const InterfacedBase &ib) const =0 |
| 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 string | tdef (const InterfacedBase &ib) const =0 |
| 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. | |
Private Attributes | |
| FileType | isFileType |
| Indicates if this parameter corresponds to a file or directory. | |
Detailed Description
template<>
class ThePEG::ThePEG::ParameterTBase< string >
This is a specialization of ParameterTBase for the string case.
- See also:
- ParameterTBase
Definition at line 788 of file Parameter.h.
Member Enumeration Documentation
| enum ThePEG::ParameterTBase< string >::FileType |
Enumerated variables to determine of a string parameter corresponds to a file or a directory.
- Enumerator:
-
NoFile Neither file nor directory. File The parameter corresponds to a file. Directory The parameter corresponds to a directory.
Definition at line 796 of file Parameter.h.
Member Function Documentation
| ThePEG::ThePEG::ParameterTBase< string >::ParameterTBase | ( | string | newName, | |
| string | newDescription, | |||
| string | newClassName, | |||
| const type_info & | newTypeInfo, | |||
| bool | depSafe, | |||
| bool | readonly | |||
| ) | [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. newClassName the name of the corresponding class. newTypeInfo the type_info object of the corresponding class. 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.
Definition at line 824 of file Parameter.h.
| virtual void ThePEG::ThePEG::ParameterTBase< string >::set | ( | InterfacedBase & | ib, | |
| string | newValue | |||
| ) | const [inline, virtual] |
Set the member variables of ib to val.
Uses a stringstream to read the val into a Type object and then calls tset(InterfacedBase &, Type).
Implements ThePEG::ParameterBase.
Definition at line 873 of file Parameter.h.
References ThePEG::StringUtils::stripws(), and ThePEG::ParameterTBase< Type >::tset().
| virtual string ThePEG::ThePEG::ParameterTBase< string >::get | ( | const InterfacedBase & | ib | ) | const [inline, virtual] |
Return the value of the member variable of ib.
Calls tget(const InterfacedBase &) and converts the returned value with an ostringstream.
Implements ThePEG::ParameterBase.
Definition at line 889 of file Parameter.h.
References ThePEG::ParameterTBase< Type >::tget().
| virtual string ThePEG::ThePEG::ParameterTBase< string >::minimum | ( | const InterfacedBase & | ) | const [inline, virtual] |
Return the minimum value allowed for the member variable of ib.
Not relevant for strings. Returns the empty string.
Implements ThePEG::ParameterBase.
Definition at line 904 of file Parameter.h.
| virtual string ThePEG::ThePEG::ParameterTBase< string >::maximum | ( | const InterfacedBase & | ) | const [inline, virtual] |
Return the maximum value allowed for the member variable of ib.
Not relevant for strings. Returns the empty string.
Implements ThePEG::ParameterBase.
Definition at line 912 of file Parameter.h.
| virtual string ThePEG::ThePEG::ParameterTBase< string >::def | ( | const InterfacedBase & | ib | ) | const [inline, virtual] |
Return the default value for the member variables of ib.
Calls tdef(const InterfacedBase &) and converts the returned value with an ostringstream.
Implements ThePEG::ParameterBase.
Definition at line 921 of file Parameter.h.
References ThePEG::ParameterTBase< Type >::tdef().
The documentation for this class was generated from the following file:
