ParameterSettableWithConfigureFunction Class Referenceabstract
The base for classes that can be configured using a ConfigurationParameters object. More...
Inheritance diagram for ParameterSettableWithConfigureFunction:
Public Member Functions | |
| ParameterSettableWithConfigureFunction () | |
| Constructor. More... | |
| virtual | ~ParameterSettableWithConfigureFunction () |
| Destructor. More... | |
| virtual void | configure (ConfigurationParameters ¶ms, QString prefix)=0 |
| Configures the object using a ConfigurationParameters object. More... | |
 Public Member Functions inherited from ParameterSettable | |
| ParameterSettable () | |
| Constructor. More... | |
| virtual | ~ParameterSettable () |
| Destructor. More... | |
| void | addObserver (RuntimeParameterObserver *obs) |
| add a RuntimeParameterObserver to this object More... | |
| template<class T > | |
| T | getRuntimeParameter (QString paramName) |
| return the value of the object's parameter previously marked as runtime modifiable More... | |
| virtual ParameterSettableUI * | getUIManager () |
| Return an instance of the ParameterSettableUI class that handle the viewers for the GUI. More... | |
| virtual void | postConfigureInitialization () |
| This function is called after all linked objects have been configured. More... | |
| void | removeObserver (RuntimeParameterObserver *obs) |
| remove the RuntimeParameterObserver to this object More... | |
| virtual void | save (ConfigurationParameters ¶ms, QString prefix)=0 |
| Saves the actual status of parameters into the ConfigurationParameters object passed. More... | |
| template<class T > | |
| void | setRuntimeParameter (QString paramName, T newvalue) |
| set the value of the object's parameter previously marked as runtime modifiable More... | |
| QString | typeName () const |
| return the type name of this object More... | |
Additional Inherited Members | |
| Public Types inherited from ParameterSettable | |
| enum | Property { Default = 0x0000, IsList = 0x0001, IsMandatory = 0x0002, AllowMultiple = 0x0004 } |
| this enum is used to describe the properties of a parameter or a subgroup in a type description More... | |
| Static Public Member Functions inherited from ParameterSettable | |
| static void | describe (QString type) |
| Add to Factory::typeDescriptions() the descriptions of all parameters and subgroups. More... | |
| static QString | fullParameterDescriptionPath (QString type, QString param) |
| helper function for creating the full path to a parameter description More... | |
| static QString | fullSubgroupDescriptionPath (QString type, QString sub) |
| helper function for creating the full path to a subgroup description More... | |
| Static Public Attributes inherited from ParameterSettable | |
| static const double | Infinity = std::numeric_limits<double>::infinity() |
| Shortcut variable for indicate an infinity double number. More... | |
| static const int | MaxInteger = std::numeric_limits<int>::max() |
| Shortcut variable for indicate the maximum int value allowed. More... | |
| static const int | MinInteger = std::numeric_limits<int>::min() |
| Shortcut variable for indicate the minimum int value allowed. More... | |
| Protected Member Functions inherited from ParameterSettable | |
| void | notifyChangesToParam (QString paramName) |
| notify observers about a changing to a runtime parameter More... | |
| Static Protected Member Functions inherited from ParameterSettable | |
| static Descriptor | addTypeDescription (QString type, QString shortHelp, QString longHelp=QString("")) |
| Add an entry for the type into the descriptions of all available types. More... | |
| template<class EditorType > | |
| static void | setGraphicalEditor (QString type) |
| Sets the graphical editor for this ParameterSettable This method sets the editor (a subclass of ConfigurationWidget) to use to modify the values of the parameters of this group (and possibly of subgroups, if the editor supports this) More... | |
Detailed Description
The base for classes that can be configured using a ConfigurationParameters object.
- Warning
- All classes that have ParameterSettable as an ancestor should be only created and configured using ConfigurationParameters. Calling configure() or postConfigureInitialization() by hand is highly discouraged (you could experience strange problems...)
Definition at line 789 of file parametersettable.h.
Constructor & Destructor Documentation
|
inline |
Constructor.
Definition at line 795 of file parametersettable.h.
|
inlinevirtual |
Destructor.
Definition at line 802 of file parametersettable.h.
Member Function Documentation
|
pure virtual |
Configures the object using a ConfigurationParameters object.
- Parameters
-
params the configuration parameters object with parameters to use prefix the prefix to use to access the object configuration parameters. This is guaranteed to end with the separator character when called by the factory, so you don't need to add one
Referenced by ConfigurationParameters::getObjectFromGroup().
The documentation for this class was generated from the following file:
- configuration/include/parametersettable.h