8.8.4.6.2. Param - Reference¶

class Param : public ito::ParamBase ¶

class for parameter handling e.g. to pass paramters to plugins

The plugins use this class to organize their parameters (internally) and for the paramList which is used for type checking whilst parsing parameters passed from python to c.

Public Functions

Param()¶

default constructor, creates “empty” Param

type-less Param with name only

Param(const ByteArray &name)¶: type-less Param with name and type

Param(const ByteArray &name, const uint32 typeAndFlags)¶: Constructor for a string value (const char*)

Param(const ByteArray &name, const uint32 typeAndFlags, const char *val, const char *info)¶: Constructor for a char value parameter (int8)

Param(const ByteArray &name, const uint32 typeAndFlags, const char minVal, const char maxVal, const char val, const char *info)¶: Constructor for an integer value parameter (int32)

Param(const ByteArray &name, const uint32 typeAndFlags, const int32 minVal, const int32 maxVal, const int32 val, const char *info)¶: Constructor for an double value parameter (float64)

Param(const ByteArray &name, const uint32 typeAndFlags, const float64 minVal, const float64 maxVal, const float64 val, const char *info)¶: Constructor for a character array parameter (int8)

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const int32 *values, const char *info)¶

< Constructor for an integer array parameter (int32)

Constructor for a double array parameter (float64)

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const float64 *values, const char *info)¶: Constructor for a complex128 array parameter.

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const complex128 *values, const char *info)¶: Constructor for a string list parameter.

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const ByteArray *values, const char *info)¶: constructor for a character value (int8)

Param(const ByteArray &name, const uint32 typeAndFlags, const char val, ParamMeta *meta, const char *info)¶: constructor for an integer value (int32)

Param(const ByteArray &name, const uint32 typeAndFlags, const int32 val, ParamMeta *meta, const char *info)¶: constructor for a double value (float64)

Param(const ByteArray &name, const uint32 typeAndFlags, const float64 val, ParamMeta *meta, const char *info)¶: constructor for a complex value (complex128)

Param(const ByteArray &name, const uint32 typeAndFlags, const complex128 val, ParamMeta *meta, const char *info)¶: constructor for int32 arrays.

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const char *values, ParamMeta *meta, const char *info)¶: constructor for int32 arrays.

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const int32 *values, ParamMeta *meta, const char *info)¶: constructor for float64 arrays.

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const float64 *values, ParamMeta *meta, const char *info)¶: constructor for complex128 arrays.

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const complex128 *values, ParamMeta *meta, const char *info)¶: constructor for a string list.

Param(const ByteArray &name, const uint32 typeAndFlags, const unsigned int size, const ByteArray *values, ParamMeta *meta, const char *info)¶: Destructor.

~Param()¶: Copy-Constructor.

Param(const Param &copyConstr)¶: rvalue copy constructor

const Param operator[](const int index) const¶

< braces operator for element-wise access in arrays

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

Param &operator=(const Param &rhs)¶: rvalue assignment operator

Param &operator=(Param &&rvalue) noexcept¶: just copies the value from the right-hand-side ParamBase (rhs) to this tParam.

inline const char *getInfo() const¶

< returns content of info string (string is not copied)

sets content of info string, if necessary the info buffer is freed first, passed string is copied

inline void setInfo(const char *info)¶: set the info string (description) to info.

inline void setInfo(const ByteArray &info)¶: returns const-pointer to meta-information instance or nullptr if not available. Cast this pointer to the right class of the parameter.

inline const ParamMeta *getMeta() const¶: returns const-pointer to meta-information instance or nullptr if not available. Cast this pointer to the right class of the parameter.

inline const ParamMeta *getConstMeta() const¶: returns pointer to meta-information instance or nullptr if not available. Cast this pointer to the right class of the parameter.

inline ParamMeta *getMeta(void)¶: returns const-pointer to meta-information instance casted to ‘const _Tp*’ or nullptr if not available or cast failed.

template<typename _Tp> inline const _Tp *getMetaT(void) const¶: returns const-pointer to meta-information instance casted to ‘const _Tp*’ or nullptr if not available or cast failed.

template<typename _Tp> inline const _Tp *getConstMetaT(void) const¶: returns pointer to meta-information instance casted to ‘_Tp*’ or nullptr if not available or cast failed.

void setMeta(ParamMeta *meta, bool takeOwnership = false)¶

sets a new ParamMeta-instance as meta information for this Param