ParameterSettable::RealDescriptor Class Reference

Utility Class for customize the description of Real valued parameter. More...

Public Member Functions
	RealDescriptor (QString paramPath)
	Add (if not exists) the description of a Real valued parameter.
RealDescriptor &	def (double defaultValue)
	set the default value when the parameter is not present into the configuration
RealDescriptor &	help (QString shortHelp, QString longHelp=QString(""))
	Add a short help comment and a complete help comment.
RealDescriptor &	limits (double lower_bound, double upper_bound)
	set the lower and the upper bounds for the parameter's value If you don't want to limit the lower_bound, specify -Infinity.
RealDescriptor &	props (Properties properties)
	set the Properties of this parameter (see Property documentation)
template<class T >
RealDescriptor &	runtime (void(T::*setter)(double), double(T::*getter)() const )
	set the runtime accessors for this parameter
template<class T >
RealDescriptor &	runtime (void(T::*setter)(float), float(T::*getter)() const )
	set the runtime accessors for this parameter

Detailed Description

Utility Class for customize the description of Real valued parameter.

Definition at line 312 of file parametersettable.h.

Constructor & Destructor Documentation

RealDescriptor

(

QString

paramPath

)

Add (if not exists) the description of a Real valued parameter.

Warning

Don't call it directly; use Descriptor::describeReal instead

Definition at line 208 of file parametersettable.cpp.

References ConfigurationParameters::createGroup(), ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().

Member Function Documentation

ParameterSettable::RealDescriptor & def

(

double

defaultValue

)

set the default value when the parameter is not present into the configuration

Definition at line 215 of file parametersettable.cpp.

References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().

ParameterSettable::RealDescriptor & help	(	QString	shortHelp,
		QString	longHelp = QString("")
	)

Add a short help comment and a complete help comment.

The short help comment is typically used as a tooltip help, while the complete help comment will be shown in the help section for the type

Parameters

shortHelp	is the short comment (rich text here is not allowed)
longHelp	is the long help (rich text here is allowed); if not specified the longHelp will be the same of the shortHelp

Definition at line 236 of file parametersettable.cpp.

References ConfigurationParameters::createParameter(), and Factory::getTypeDescriptions().

ParameterSettable::RealDescriptor & limits	(	double	lower_bound,
		double	upper_bound
	)

set the lower and the upper bounds for the parameter's value If you don't want to limit the lower_bound, specify -Infinity.

If you don't want to limit the upper_bound, specify +Infinity.

Parameters

lower_bound	is the minimum number allowed for the parameter
upper_bound	is the maximum number allowed for the parameter

Definition at line 225 of file parametersettable.cpp.

References ConfigurationParameters::createParameter(), Factory::getTypeDescriptions(), and ParameterSettable::Infinity.

ParameterSettable::RealDescriptor & props

(

Properties

properties

)

set the Properties of this parameter (see Property documentation)

Definition at line 220 of file parametersettable.cpp.

References Factory::getTypeDescriptions().

RealDescriptor& runtime ( void(T::*)(double)  setter, double(T::*)() const  getter  )

inline

set the runtime accessors for this parameter

When a parameter is marked as runtime, it means that the value of the parameter can be changed in any moment using the setRuntimeParameter method bypassing the configure method.

Parameters

setter	is the pointer-to-member to the method used for setting the value of the parameter; it must accept one double argument and return void
getter	is the pointer-to-member to the method used for getting the value of the parameter; it must accept no arguments and return double

Definition at line 339 of file parametersettable.h.

RealDescriptor& runtime ( void(T::*)(float)  setter, float(T::*)() const  getter  )

inline

set the runtime accessors for this parameter

When a parameter is marked as runtime, it means that the value of the parameter can be changed in any moment using the setRuntimeParameter method bypassing the configure method.

Parameters

setter	is the pointer-to-member to the method used for setting the value of the parameter; it must accept one float argument and return void
getter	is the pointer-to-member to the method used for getting the value of the parameter; it must accept no arguments and return float

Definition at line 355 of file parametersettable.h.

---

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

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