itom 2.2.0
|
class for parameter handling e.g. to pass paramters to plugins More...
#include <param.h>
Public Member Functions | |
Param () | |
default constructor, creates "empty" tParam | |
Param (const ByteArray &name) | |
Param (const ByteArray &name, const uint32 type) | |
Param (const ByteArray &name, const uint32 type, const char *val, const char *info) | |
Param (const ByteArray &name, const uint32 type, const char minVal, const char maxVal, const char val, const char *info) | |
Param (const ByteArray &name, const uint32 type, const int32 minVal, const int32 maxVal, const int32 val, const char *info) | |
Param (const ByteArray &name, const uint32 type, const float64 minVal, const float64 maxVal, const float64 val, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const char *values, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const int32 *values, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const float64 *values, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const complex128 *values, const char *info) | |
Param (const ByteArray &name, const uint32 type, const char val, ParamMeta *meta, const char *info) | |
Param (const ByteArray &name, const uint32 type, const int32 val, ParamMeta *meta, const char *info) | |
Param (const ByteArray &name, const uint32 type, const float64 val, ParamMeta *meta, const char *info) | |
Param (const ByteArray &name, const uint32 type, const complex128 val, ParamMeta *meta, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const char *values, ParamMeta *meta, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const int32 *values, ParamMeta *meta, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const float64 *values, ParamMeta *meta, const char *info) | |
Param (const ByteArray &name, const uint32 type, const unsigned int size, const complex128 *values, ParamMeta *meta, const char *info) | |
~Param () | |
Destructor. | |
Param (const Param ©Constr) | |
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) | |
void | setInfo (const char *info) |
void | setInfo (const ByteArray &info) |
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 | |
float64 | getMin () const |
float64 | getMax () const |
Private Attributes | |
ParamMeta * | m_pMeta |
ByteArray | m_info |
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.
const char* ito::Param::getInfo | ( | void | ) | const [inline] |
< 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
float64 ito::Param::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.
float64 ito::Param::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.
void ito::Param::setMeta | ( | ParamMeta * | meta, |
bool | takeOwnership = false |
||
) |
sets a new ParamMeta-instance as meta information for this Param
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 |