Alida-C++ 0.1
|
Class to describe parameters of an operator. More...
#include <ALDOpParameterDescriptor.h>
Public Member Functions | |
ALDOpParameterDescriptor (std::string _name, std::string _typeIdStr, std::string _typeNiceName, ALDParameterDirection _direction, bool _required, bool _supplemental, std::string _label, std::string _explanation, void *_defaultValue) | |
Default constructor. | |
~ALDOpParameterDescriptor () | |
Default destructor. | |
Public Attributes | |
const std::string | name |
Name of the parameter. | |
const std::string | typeIdStr |
Type identifier string. | |
const std::string | typeNiceName |
User-readable type name. | |
const ALDParameterDirection | direction |
Direction of parameter, i.e. IN, INOUT or OUT. | |
const bool | required |
Flag for indicating if parameter is required or not. | |
const bool | supplemental |
Flag for indicating if parameter is supplemental or not. | |
const std::string | label |
Expressive label describing the parameter. | |
const std::string | explanation |
Short explanation of the parameters intention. | |
const void * | defaultValue |
Default value for the parameter. | |
void * | value |
Value of the parameter. |
Class to describe parameters of an operator.
Definition at line 58 of file ALDOpParameterDescriptor.h.
ALDOpParameterDescriptor::ALDOpParameterDescriptor | ( | std::string | _name, |
std::string | _typeIdStr, | ||
std::string | _typeNiceName, | ||
ALDParameterDirection | _direction, | ||
bool | _required, | ||
bool | _supplemental, | ||
std::string | _label, | ||
std::string | _explanation, | ||
void * | _defaultValue | ||
) |
Default constructor.
_name | Name of the parameter. |
_typeIdStr | Type identifier string. |
_typeNiceName | User-readable name of parameter type. |
_direction | Direction of the parameter. |
_required | Flag to declare parameter required. |
_supplemental | Flag to declare parameter supplemental. |
_label | Label for the parameter (e.g. for GUIs). |
_explanation | Description for the parameter. |
_defaultValue | Default value. |
Definition at line 55 of file ALDOpParameterDescriptor.cc.
References value.
Alida::ALDOpParameterDescriptor::~ALDOpParameterDescriptor | ( | ) | [inline] |
Default destructor.
Definition at line 90 of file ALDOpParameterDescriptor.h.
const void* Alida::ALDOpParameterDescriptor::defaultValue |
Default value for the parameter.
Definition at line 79 of file ALDOpParameterDescriptor.h.
Direction of parameter, i.e. IN, INOUT or OUT.
Definition at line 69 of file ALDOpParameterDescriptor.h.
const std::string Alida::ALDOpParameterDescriptor::explanation |
Short explanation of the parameters intention.
Definition at line 77 of file ALDOpParameterDescriptor.h.
const std::string Alida::ALDOpParameterDescriptor::label |
Expressive label describing the parameter.
Definition at line 75 of file ALDOpParameterDescriptor.h.
const std::string Alida::ALDOpParameterDescriptor::name |
Name of the parameter.
Definition at line 63 of file ALDOpParameterDescriptor.h.
const bool Alida::ALDOpParameterDescriptor::required |
Flag for indicating if parameter is required or not.
Definition at line 71 of file ALDOpParameterDescriptor.h.
Flag for indicating if parameter is supplemental or not.
Definition at line 73 of file ALDOpParameterDescriptor.h.
const std::string Alida::ALDOpParameterDescriptor::typeIdStr |
Type identifier string.
Definition at line 65 of file ALDOpParameterDescriptor.h.
const std::string Alida::ALDOpParameterDescriptor::typeNiceName |
User-readable type name.
Definition at line 67 of file ALDOpParameterDescriptor.h.
Value of the parameter.
Definition at line 81 of file ALDOpParameterDescriptor.h.
Referenced by ALDOpParameterDescriptor().