This is the base class for the hierarchy for wrapping the methods for setting a runtime modifiable parameter. More...

Inheritance diagram for RuntimeParameterSetter:

Public Member Functions
	RuntimeParameterSetter (QString descrPath)
	constructor

virtual	~RuntimeParameterSetter ()
	destructor

virtual void	get (ParameterSettable *object, QString &ret)
	Return the value of the object's parameter supposing that the parameter's type is QString.

virtual void	get (ParameterSettable *object, int &ret)
	Return the value of the object's parameter supposing that the parameter's type is int.

virtual void	get (ParameterSettable *object, unsigned int &ret)
	Return the value of the object's parameter supposing that the parameter's type is unsigned int.

virtual void	get (ParameterSettable *object, double &ret)
	Return the value of the object's parameter supposing that the parameter's type is double.

virtual void	get (ParameterSettable *object, float &ret)
	Return the value of the object's parameter supposing that the parameter's type is float.

virtual void	get (ParameterSettable *object, bool &ret)
	Return the value of the object's parameter supposing that the parameter's type is boolean.

QString	getDescriptionPath ()
	return the full path to the description of this parameter

QString	getName ()
	return the name of this runtime modifiable parameter

virtual QString	set (ParameterSettable *object, QString newvalue)
	Set the value of the object's parameter supposing that the parameter's type is QString.

virtual int	set (ParameterSettable *object, int newvalue)
	Set the value of the object's parameter supposing that the parameter's type is int.

virtual unsigned int	set (ParameterSettable *object, unsigned int newvalue)
	Set the value of the object's parameter supposing that the parameter's type is unsigned int.

virtual double	set (ParameterSettable *object, double newvalue)
	Set the value of the object's parameter supposing that the parameter's type is double.

virtual float	set (ParameterSettable *object, float newvalue)
	Set the value of the object's parameter supposing that the parameter's type is float.

virtual bool	set (ParameterSettable *object, bool newvalue)
	Set the value of the object's parameter supposing that the parameter's type is boolean.

Protected Attributes
QString	descrPath
	the full path to the description of this parameter

QString	name
	the name of the runtime modifiable parameter

Detailed Description

This is the base class for the hierarchy for wrapping the methods for setting a runtime modifiable parameter.

Definition at line 48 of file runtimeparametersetters.h.

Constructor & Destructor Documentation

RuntimeParameterSetter ( QString descrPath )

inline

constructor

Definition at line 51 of file runtimeparametersetters.h.

virtual ~RuntimeParameterSetter ( )

inlinevirtual

destructor

Definition at line 56 of file runtimeparametersetters.h.

Member Function Documentation

void get	(	ParameterSettable *	object,
		QString &	ret
	)

virtual

Return the value of the object's parameter supposing that the parameter's type is QString.

Parameters

object	is the owner of the parameter
ret	is the reference variable on which the value is returned

Definition at line 64 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

Referenced by ParameterSettable::getRuntimeParameter().

void get	(	ParameterSettable *	object,
		int &	ret
	)

virtual

Return the value of the object's parameter supposing that the parameter's type is int.

Parameters

object	is the owner of the parameter
ret	is the reference variable on which the value is returned

Definition at line 69 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

void get	(	ParameterSettable *	object,
		unsigned int &	ret
	)

virtual

Return the value of the object's parameter supposing that the parameter's type is unsigned int.

Parameters

object	is the owner of the parameter
ret	is the reference variable on which the value is returned

Definition at line 74 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

void get	(	ParameterSettable *	object,
		double &	ret
	)

virtual

Return the value of the object's parameter supposing that the parameter's type is double.

Parameters

object	is the owner of the parameter
ret	is the reference variable on which the value is returned

Definition at line 79 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

void get	(	ParameterSettable *	object,
		float &	ret
	)

virtual

Return the value of the object's parameter supposing that the parameter's type is float.

Parameters

object	is the owner of the parameter
ret	is the reference variable on which the value is returned

Definition at line 84 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

void get	(	ParameterSettable *	object,
		bool &	ret
	)

virtual

Return the value of the object's parameter supposing that the parameter's type is boolean.

Parameters

object	is the owner of the parameter
ret	is the reference variable on which the value is returned

Definition at line 89 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

QString getDescriptionPath ( )

inline

return the full path to the description of this parameter

Definition at line 126 of file runtimeparametersetters.h.

QString getName ( )

inline

return the name of this runtime modifiable parameter

Definition at line 124 of file runtimeparametersetters.h.

QString set	(	ParameterSettable *	object,
		QString	newvalue
	)

virtual

Set the value of the object's parameter supposing that the parameter's type is QString.

Parameters

object	is the owner of the parameter
newvalue	the new value for the parameter

Returns: the actual value of the parameter after the change; might be different from newvalue

Definition at line 28 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

Referenced by ParameterSettable::setRuntimeParameter().

int set	(	ParameterSettable *	object,
		int	newvalue
	)

virtual

Set the value of the object's parameter supposing that the parameter's type is int.

Parameters

object	is the owner of the parameter
newvalue	the new value for the parameter

Returns: the actual value of the parameter after the change; might be different from newvalue

Definition at line 34 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

unsigned int set	(	ParameterSettable *	object,
		unsigned int	newvalue
	)

virtual

Set the value of the object's parameter supposing that the parameter's type is unsigned int.

Parameters

object	is the owner of the parameter
newvalue	the new value for the parameter

Returns: the actual value of the parameter after the change; might be different from newvalue

Definition at line 40 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

double set	(	ParameterSettable *	object,
		double	newvalue
	)

virtual

Set the value of the object's parameter supposing that the parameter's type is double.

Parameters

object	is the owner of the parameter
newvalue	the new value for the parameter

Returns: the actual value of the parameter after the change; might be different from newvalue

Definition at line 46 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

float set	(	ParameterSettable *	object,
		float	newvalue
	)

virtual

Set the value of the object's parameter supposing that the parameter's type is float.

Parameters

object	is the owner of the parameter
newvalue	the new value for the parameter

Returns: the actual value of the parameter after the change; might be different from newvalue

Definition at line 52 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

bool set	(	ParameterSettable *	object,
		bool	newvalue
	)

virtual

Set the value of the object's parameter supposing that the parameter's type is boolean.

Parameters

object	is the owner of the parameter
newvalue	the new value for the parameter

Returns: the actual value of the parameter after the change; might be different from newvalue

Definition at line 58 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::descrPath, ConfigurationHelper::getString(), Factory::getTypeDescriptions(), and RuntimeParameterSetter::name.

Member Data Documentation

QString descrPath

protected

the full path to the description of this parameter

Definition at line 131 of file runtimeparametersetters.h.

Referenced by RuntimeParameterSetter::get(), and RuntimeParameterSetter::set().

QString name

protected

the name of the runtime modifiable parameter

Definition at line 126 of file runtimeparametersetters.h.

Referenced by RuntimeParameterSetter::get(), and RuntimeParameterSetter::set().

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

configuration/include/runtimeparametersetters.h
configuration/src/runtimeparametersetters.cpp

Configuration - 1.2.3

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation