Configuration - 1.2.3

Utilities Configuration GA
NNFW WorldSim Total 99% Experiments
Public Member Functions | List of all members
ParameterSettable::ObjectDescriptor Class Reference
Factory

Utility Class for customize the description of an object parameter. More...

Public Member Functions

 ObjectDescriptor (QString paramPath)
 Add (if not exists) the description of a object parameter.
 
ObjectDescriptor & help (QString shortHelp, QString longHelp=QString(""))
 Add a short help comment and a complete help comment.
 
ObjectDescriptor & props (Properties properties)
 set the Properties of this parameter (see Property documentation)
 
ObjectDescriptor & type (QString className)
 set the class of the object (it includes also all subclasses)
 

Detailed Description

Utility Class for customize the description of an object parameter.

Definition at line 461 of file parametersettable.h.

Constructor & Destructor Documentation

ObjectDescriptor ( QString  paramPath)

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

Warning
Don't call it directly; use Descriptor::describeObject instead

Definition at line 302 of file parametersettable.cpp.

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

Member Function Documentation

ParameterSettable::ObjectDescriptor & 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
shortHelpis the short comment (rich text here is not allowed)
longHelpis the long help (rich text here is allowed); if not specified the longHelp will be the same of the shortHelp

Definition at line 319 of file parametersettable.cpp.

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

ParameterSettable::ObjectDescriptor & props ( Properties  properties)

set the Properties of this parameter (see Property documentation)

Definition at line 309 of file parametersettable.cpp.

References Factory::getTypeDescriptions().

ParameterSettable::ObjectDescriptor & type ( QString  className)

set the class of the object (it includes also all subclasses)

Definition at line 314 of file parametersettable.cpp.

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

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