Alida-C++ 0.1

Alida::ALDOpParameterDescriptor Class Reference

Class to describe parameters of an operator. More...

#include <ALDOpParameterDescriptor.h>

Collaboration diagram for Alida::ALDOpParameterDescriptor:

List of all members.

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.

Detailed Description

Class to describe parameters of an operator.

Definition at line 58 of file ALDOpParameterDescriptor.h.


Constructor & Destructor Documentation

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.

Parameters:
_nameName of the parameter.
_typeIdStrType identifier string.
_typeNiceNameUser-readable name of parameter type.
_directionDirection of the parameter.
_requiredFlag to declare parameter required.
_supplementalFlag to declare parameter supplemental.
_labelLabel for the parameter (e.g. for GUIs).
_explanationDescription for the parameter.
_defaultValueDefault 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.


Member Data Documentation

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.

Short explanation of the parameters intention.

Definition at line 77 of file ALDOpParameterDescriptor.h.

Expressive label describing the parameter.

Definition at line 75 of file ALDOpParameterDescriptor.h.

Name of the parameter.

Definition at line 63 of file ALDOpParameterDescriptor.h.

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.

Type identifier string.

Definition at line 65 of file ALDOpParameterDescriptor.h.

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().


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines