ParameterSettableWithConfigureFunction Class Reference

The base for classes that can be configured using a ConfigurationParameters object. More...

Inheritance diagram for ParameterSettableWithConfigureFunction:

List of all members.

Public Member Functions
	ParameterSettableWithConfigureFunction ()
	Constructor.
virtual	~ParameterSettableWithConfigureFunction ()
	Destructor.
virtual void	configure (ConfigurationParameters &params, QString prefix)=0
	Configures the object using a ConfigurationParameters object.

---

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

---

Constructor & Destructor Documentation

ParameterSettableWithConfigureFunction

(

)

[inline]

Constructor.

Definition at line 760 of file parametersettable.h.

virtual ~ParameterSettableWithConfigureFunction

(

)

[inline, virtual]

Destructor.

Definition at line 767 of file parametersettable.h.

---

Member Function Documentation

virtual void configure	(	ConfigurationParameters &	params,
		QString	prefix
	)		[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