RuntimeParameterSetter Class Reference

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

Inheritance diagram for RuntimeParameterSetter:

List of all members.

Public Member Functions
	RuntimeParameterSetter (QString name, int)
	constructor
	RuntimeParameterSetter (QString name, unsigned int)
	constructor
	RuntimeParameterSetter (QString name, float)
	constructor
	RuntimeParameterSetter (QString name, bool)
	constructor
	RuntimeParameterSetter (QString name, double)
	constructor
virtual	~RuntimeParameterSetter ()
	destructor
QString	getName ()
	return the name of this runtime modifiable parameter
QString	getType ()
	return the type of this runtime modifiable parameter
virtual float	set (float newvalue)
	Set the value of the parameter supposing that the parameter's type is float.
virtual bool	set (bool newvalue)
	Set the value of the parameter supposing that the parameter's type is boolean.
virtual unsigned int	set (unsigned int newvalue)
	Set the value of the parameter supposing that the parameter's type is unsigned int.
virtual double	set (double newvalue)
	Set the value of the parameter supposing that the parameter's type is double.
virtual int	set (int newvalue)
	Set the value of the parameter supposing that the parameter's type is int.
Protected Attributes
const QString	name
	the name of the runtime modifiable parameter
const QString	type
	the type of the parameter

---

Detailed Description

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

Definition at line 30 of file runtimeparametersetters.h.

---

Constructor & Destructor Documentation

RuntimeParameterSetter	(	QString	name,
		int
	)		[inline]

constructor

Definition at line 33 of file runtimeparametersetters.h.

RuntimeParameterSetter	(	QString	name,
		unsigned	int
	)		[inline]

constructor

Definition at line 35 of file runtimeparametersetters.h.

RuntimeParameterSetter	(	QString	name,
		double
	)		[inline]

constructor

Definition at line 37 of file runtimeparametersetters.h.

RuntimeParameterSetter	(	QString	name,
		float
	)		[inline]

constructor

Definition at line 39 of file runtimeparametersetters.h.

RuntimeParameterSetter	(	QString	name,
		bool
	)		[inline]

constructor

Definition at line 41 of file runtimeparametersetters.h.

virtual ~RuntimeParameterSetter

(

)

[inline, virtual]

destructor

Definition at line 43 of file runtimeparametersetters.h.

---

Member Function Documentation

QString getName

(

)

[inline]

return the name of this runtime modifiable parameter

Definition at line 70 of file runtimeparametersetters.h.

QString getType

(

)

[inline]

return the type of this runtime modifiable parameter

Definition at line 72 of file runtimeparametersetters.h.

double set

(

double

newvalue

)

[virtual]

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

Parameters:

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 36 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::name, and RuntimeParameterSetter::type.

bool set

(

bool

newvalue

)

[virtual]

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

Parameters:

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::name, and RuntimeParameterSetter::type.

float set

(

float

newvalue

)

[virtual]

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

Parameters:

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 41 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::name, and RuntimeParameterSetter::type.

int set

(

int

newvalue

)

[virtual]

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

Parameters:

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 26 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::name, and RuntimeParameterSetter::type.

Referenced by ParameterSettable::setRuntimeParameter().

unsigned int set

(

unsigned int

newvalue

)

[virtual]

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

Parameters:

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 31 of file runtimeparametersetters.cpp.

References RuntimeParameterSetter::name, and RuntimeParameterSetter::type.

---

Member Data Documentation

const QString name [protected]

the name of the runtime modifiable parameter

Definition at line 72 of file runtimeparametersetters.h.

Referenced by RuntimeParameterSetter::set().

const QString type [protected]

the type of the parameter

Definition at line 77 of file runtimeparametersetters.h.

Referenced by RuntimeParameterSetter::set().

---

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

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