Common::Parameter Namespace Reference

Classes
class	ICapeNLPRealParameterSpec
class	ICapeParameterSpec
class	ICapeRealParameterSpec
class	ICapeIntegerParameterSpec
class	ICapeBooleanParameterSpec
class	ICapePointerParameterSpec
class	ICapeOptionParameterSpec
class	ICapeParameter
Typedefs
typedef enum Common::Parameter::eCapeParamType	CapeParamType
typedef enum Common::Parameter::eCapeParamMode	CapeParamMode
typedef std::vector < ICapeParameter * >	CapeArrayParameter
	Cape Open ICapeParameter pointers array type.
typedef std::vector < ICapeParameterSpec * >	CapeArrayParameterSpec
	Cape Open ICapeParameterSpec pointers long array type.
Enumerations
enum	eCapeParamType {   CAPE_NONE, CAPE_REAL, CAPE_INT, CAPE_OPTION,   CAPE_BOOLEAN, CAPE_ARRAY, CAPE_ARRAY_STRING, CAPE_POINTER,   DIANA_ARRAY_PARAMETERS, DIANA_ARRAY_REAL }
enum	eCapeParamMode { CAPE_INPUT, CAPE_OUTPUT, CAPE_INPUT_OUTPUT }

---

Detailed Description

Cape-Open parameter common interface namespace (reference document "Parameter Common Interface" http://merkur.informatik.rwth-aachen.de/pub/bscw.cgi/d1061224/Parameter%20Common%20Interface.pdf).

---

Typedef Documentation

typedef std::vector<ICapeParameter*> CapeArrayParameter

Cape Open ICapeParameter pointers array type.

Diana type redefinition of the array of pointers class.

typedef enum Common::Parameter::eCapeParamMode CapeParamMode

Mode in which the unit will interpret the parameter.

typedef enum Common::Parameter::eCapeParamType CapeParamType

Type of the parameter.

---

Enumeration Type Documentation

enum eCapeParamMode

Mode in which the unit will interpret the parameter.

Enumerator:

CAPE_INPUT	Input. The Unit(or whichever owner component) will use its value to calculate.
CAPE_OUTPUT	Output. The Unit will place in the parameter a result of its calculations.
CAPE_INPUT_OUTPUT	Input-Output. The user inputs an initial estimation value and the user outputs a calculated value.

enum eCapeParamType

Type of the parameter.

Enumerator:

CAPE_REAL	real
CAPE_INT	integer
CAPE_OPTION	option
CAPE_BOOLEAN	boolean
CAPE_ARRAY	array
CAPE_ARRAY_STRING	array of strings
CAPE_POINTER	pointer parameter
DIANA_ARRAY_PARAMETERS	Diana parameters array
DIANA_ARRAY_REAL	Diana real array