7.8.4.6.1. ParamBase - Reference

class ito::ParamBase

Subclassed by ito::Param

Public Functions

inline ParamBase()

default constructor, creates “empty” ParamBase

ParamBase(const ByteArray &name)

constructor with name only

creates a new

ParamBase with name “name”, string is copied
Return

new ParamBase name “name”

Parameters

ParamBase(const ByteArray &name, const uint32 type)

constructor with name and type

creates a new

Param with name and type, string is copied
Return

new Param with name and type

Parameters

  • [in] name: name of new ParamBase

  • [in] type: type of new ParamBase for possible types see Type

ParamBase(const ByteArray &name, const uint32 type, const char *val)

constructor with name and type, char val and optional info

creates a new

ParamBase with name, type, string value. Strings are copied
Return

new ParamBase with name, type, string value

Parameters

  • [in] name: name of new ParamBase

  • [in] type: type of new ParamBase for possible types see Type

  • [in] val: character pointer to string pointer

  • [in] info: character pointer to string pointer holding information about this ParamBase

ParamBase(const ByteArray &name, const uint32 type, const float64 val)

constructor with name and type, float64 val

creates a new

ParamBase with name, type and val. Strings are copied.
Return

new ParamBase with name, type and val

Parameters

  • [in] name: name of new ParamBase

  • [in] type: type of new ParamBase for possible types see Type

  • [in] val: actual value

ParamBase(const ByteArray &name, const uint32 type, const int32 val)

constructor with name and type and int val

creates a new

ParamBase with name, type and val
Return

new ParamBase with name, type andval.

Parameters

  • [in] name: name of new ParamBase

  • [in] type: type of new ParamBase for possible types see Type

  • [in] val: actual value

ParamBase(const ByteArray &name, const uint32 type, const complex128 val)

constructor with name and type, double val

creates a new

ParamBase with name, type and val. Strings are copied.
Return

new ParamBase with name, type and val

Parameters

  • [in] name: name of new ParamBase

  • [in] type: type of new ParamBase for possible types see Type

  • [in] val: actual value

virtual ~ParamBase()

destructor

clear (frees) the name and in case a string value.

ParamBase(const ParamBase &copyConstr)

copy constructor

creates

ParamBase according to passed Param, strings are copied
Return

new ParamBase with copied values

Parameters

const ParamBase operator[](const int num) const

braces operator for element-wise access in arrays

braces operator

returns the value of the index num from the array

Return

new tParam with values of ParamBase[num] in the array

Parameters

  • [in] num: array index for which the value should be returned

ParamBase &operator=(const ParamBase &rhs)

assignment operator (sets values of lhs to values of rhs Param, strings are copied)

assignment operator

sets values of lhs to values of rhs

ParamBase, strings are copied
Return

new ParamBase with copied values

Parameters

ito::RetVal copyValueFrom(const ito::ParamBase *rhs)

just copies the value from the right-hand-side tParam (rhs) to this tParam.

inline bool isNumeric(void) const

returns true if Param is of type char, int, double or complex

inline bool isNumericArray(void) const

returns true if Param is of type char array, int array, double array or complex array

inline bool isValid(void) const

returns whether Param contains a valid type (true) or is an empty parameter (false, type == 0). The default tParam-constructor is always an invalid tParam.

inline uint32 getType(bool filterFlags = true) const

returns parameter type (autosave flag and other flags (like in, out or readonly) are only included if filterFlags is set false)

inline uint32 getFlags(void) const

returns parameter flags

inline void setFlags(const uint32 flags)

sets parameter flagsfor possible flags see tParamType

inline const char *getName(void) const

returns parameter name (returned string is no copy, do not delete it)

inline bool getAutosave(void) const

returns content of autosave flag - this flag determines whether the parameter value gets automagically saved to xml file when an instance of a plugin class is deleted (closed)

inline void setAutosave(const bool autosave)

sets content of autosave flag - this flag determines whether the parameter value gets automagically saved to xml file when an instance of a plugin class is deleted (closed)

int getLen(void) const

returns length of array parameters or -1 if no array is given. For string parameter returns length of string or 0 if not given, for number parameters return 1. In all other cases -1.

template<typename _Tp>
inline ito::RetVal setVal(_Tp val)

setVal set parameter value - templated version

Return

RetVal with operation status sets the parameter value to the passed value, if the parameter type is inadequate it is set to the maximum value of template type

Parameters

  • [in] val: value to set to

template<typename _Tp>
inline ito::RetVal setVal(_Tp val, int len)

setVal set parameter value - templated version for arrays

Return

RetVal with operation status sets the parameter value to the passed value, if the length is below 1 or a Null pointer is passed an error is returned

Parameters

  • [in] val: value to set to

  • [in] len: length of array

template<typename _Tp>
inline _Tp getVal(void) const

getVal read parameter value - templated version

returns the actual parameter value casted to the template parameter type. If the tParam has a non numeric type the largest value for the template type is passed.

Return

parameter value (numeric, casted)

template<typename _Tp>
inline _Tp getVal(int &len) const

getVal read parameter value - templated version for arrays

returns the actual parameter value casted to the template parameter type. In ‘len’ is returned what is supposed to be the length of the array. As only array references are used within tParam the actual size may differ.

Parameters

  • [out] len: length of array