Param - Reference

class ito::Param

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” tParam

~Param()

Destructor.

Param(const Param & copyConstr)

Copy-Constructor.

const Param operator[](const int num) const

braces operator for element-wise access in arrays

Param & operator=(const Param & rhs)

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

ito::RetVal copyValueFrom(const ParamBase * rhs)

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

const char * getInfo(void) 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

const ParamMeta * getMeta(void) const

returns const-pointer to meta-information instance or NULL if not available

ParamMeta * getMeta(void)

returns pointer to meta-information instance or NULL if not available

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

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

See

ito::ParamMeta

Parameters

• meta -

  is the pointer to any instance derived from ParamMeta

• takeOwnership -

  (default: false) defines, whether this Param should take the ownership of the ParamMeta-instance

double getMin() const

returns minimum value of parameter if this is available and exists.

This method is a wrapper method for ((ito::IntMeta*)getMeta())->getMax()... and returns the minimum value of the underlying meta information. It only returns a valid value for meta structures of type char, charArray, int, intArray, interval, range, double, doubleMeta.

Return

minimum value of -Inf maximum does not exist

double getMax() const

returns maximum value of parameter if this is available and exists.

This method is a wrapper method for ((ito::IntMeta*)getMeta())->getMax()... and returns the maximum value of the underlying meta information. It only returns a valid value for meta structures of type char, charArray, int, intArray, range, double, doubleMeta.

Return

maximum value of Inf maximum does not exist