ParameterSettableInConstructor Class Reference

The base for classes that can be configured using a ConfigurationParameters object passed to the constructor. More...

Inheritance diagram for ParameterSettableInConstructor:

Public Member Functions
	ParameterSettableInConstructor ()
	Constructor.
	ParameterSettableInConstructor (ConfigurationParameters &, QString)
	Constructor.
virtual	~ParameterSettableInConstructor ()
	Destructor.
Public Member Functions inherited from ParameterSettable
	ParameterSettable ()
	Constructor.
virtual	~ParameterSettable ()
	Destructor.
void	addObserver (RuntimeParameterObserver *obs)
	add a RuntimeParameterObserver to this object
template<class T >
T	getRuntimeParameter (QString paramName)
	return the value of the object's parameter previously marked as runtime modifiable
virtual ParameterSettableUI *	getUIManager ()
	Return an instance of the ParameterSettableUI class that handle the viewers for the GUI.
virtual void	postConfigureInitialization ()
	This function is called after all linked objects have been configured.
void	removeObserver (RuntimeParameterObserver *obs)
	remove the RuntimeParameterObserver to this object
virtual void	save (ConfigurationParameters &params, QString prefix)=0
	Saves the actual status of parameters into the ConfigurationParameters object passed.
template<class T >
void	setRuntimeParameter (QString paramName, T newvalue)
	set the value of the object's parameter previously marked as runtime modifiable
QString	typeName () const
	return the type name of this object

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.
static QString	fullParameterDescriptionPath (QString type, QString param)
	helper function for creating the full path to a parameter description
static QString	fullSubgroupDescriptionPath (QString type, QString sub)
	helper function for creating the full path to a subgroup description
Static Public Attributes inherited from ParameterSettable
static const double	Infinity = std::numeric_limits<double>::infinity()
	Shortcut variable for indicate an infinity double number.
static const int	MaxInteger = std::numeric_limits<int>::max()
	Shortcut variable for indicate the maximum int value allowed.
static const int	MinInteger = std::numeric_limits<int>::min()
	Shortcut variable for indicate the minimum int value allowed.
Protected Member Functions inherited from ParameterSettable
void	notifyChangesToParam (QString paramName)
	notify observers about a changing to a runtime parameter
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.
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)

Detailed Description

The base for classes that can be configured using a ConfigurationParameters object passed to the constructor.

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 741 of file parametersettable.h.

Constructor & Destructor Documentation

ParameterSettableInConstructor ( )

inline

Constructor.

This is here to allow child classes to be constructed even without a configuration parameter object

Definition at line 750 of file parametersettable.h.

ParameterSettableInConstructor ( ConfigurationParameters &  , QString    )

inline

Constructor.

Parameters are here just to remind the user of this class that you need a ConfigurationParameters and a prefix as parameters for the constructor to build an object of this kind

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

Definition at line 767 of file parametersettable.h.

virtual ~ParameterSettableInConstructor ( )

inlinevirtual

Destructor.

Definition at line 774 of file parametersettable.h.

---

The documentation for this class was generated from the following file:

• configuration/include/parametersettable.h