The class ParamMeta is the base class for all meta information classes. Parameters of class Param may contain pointers of that class, which then must be casted to the final implementation.
Base class for all meta-information classes.
Public Functions
- See
- IntMeta, DoubleMeta, CharMeta, StringMeta, HWMeta, DObjMeta
ParamMeta()ParamMeta(uint32 type)~ParamMeta()uint32 getType()
The classes CharMeta, IntMeta and DoubleMeta provide meta information for parameters of numeric types as well as their corresponding arrays.
Meta-information for Param of type Char or CharArray.
Public Functions
- See
- ito::Param
Public Static FunctonsCharMeta(char minVal, char maxVal)constructor with minimum and maximum value
char getMin()returns minimum value
char getMax()returns maximum value
void setMin(char val)sets the minimum value
- Parameters
- val -
is the new minimum value, if this is bigger than the current maximum value, the maximum value is changed to val, too
void setMax(char val)sets the maximum value
- Parameters
- val -
is the new maximum value, if this is smaller than the current minimum value, the minimum value is changed to val, too
Meta-information for Param of type Int or IntArray.
Public Functions
- See
- ito::Param
Public Static FunctonsIntMeta(int minVal, int maxVal)constructor with minimum and maximum value
int getMin()returns minimum value
int getMax()returns maximum value
void setMin(int val)sets the minimum value
- Parameters
- val -
is the new minimum value, if this is bigger than the current maximum value, the maximum value is changed to val, too
void setMax(int val)sets the maximum value
- Parameters
- val -
is the new maximum value, if this is smaller than the current minimum value, the minimum value is changed to val, too
Meta-information for Param of type Double or DoubleArray.
Public Functions
- See
- ito::Param
Public Static FunctonsDoubleMeta(double minVal, double maxVal)constructor with minimum and maximum value
double getMin()returns minimum value
double getMax()returns maximum value
void setMin(double val)sets the minimum value
- Parameters
- val -
is the new minimum value, if this is bigger than the current maximum value, the maximum value is changed to val, too
void setMax(double val)sets the maximum value
- Parameters
- val -
is the new maximum value, if this is smaller than the current minimum value, the minimum value is changed to val, too
DoubleMeta * all()returns a new instance of DoubleMeta, where the min and max are set to the full range available for double.
By this meta information you can give information about restrictions of strings to different strings. These strings can be interpreted as pure strings, as wildcard-expressions or regular expressions. The corresponding checks must be defined manually. If a string-parameter has an enumeration defined, where the strings are interpreted as strings, and if this parameter will automatically be parsed by any input mask in the GUI, the corresponding input text box becomes a drop-down menu with the given enumeration elements.
Meta-information for Param of type String.
Public Type
- See
- ito::Param
Public FunctionstType enum
Values:
- String -
string elements should be considered as strings (exact match)
- Wildcard -
string elements should be considered as wildcard-expressions (e.g. *.doc)
- RegExp -
string elements should be considered as regular expressions (e.g. ^(.*)[abc]{1,5}$)
StringMeta(tType type)constructor
Returns a meta information class for string-types.
- See
- tType
- Parameters
- type -
indicates how the string elements should be considered
StringMeta(tType type, const char * val)constructor
Returns a meta information class for string-types.
- See
- tType
- Parameters
- type -
indicates how the string elements should be considered
- val -
adds a first string to the element list
StringMeta(const StringMeta & cpy)copy constructor
~StringMeta()destructor
tType getStringType()returns the type how strings in list should be considered.
- See
- tType
size_t getLen()returns the number of string elements in meta information class.
const char * getString(size_t idx = 0)returns string from list at index position or NULL, if index is out of range.
void addItem(const char * val)
- Parameters
- val -
adds another element to the string list.
StringMeta & operator+=(const char * val)
This meta information class provides further information about allowed types and boundaries concerning the dimension of a data object.
Meta-information for Param of type DObjPtr.
Public Functions
- See
- ito::Param
DObjMeta(uint32 allowedTypes = 0xFFFF, size_t minDim = 0, size_t maxDim = std::numeric_limits< int >::max())int getAllowedTypes()size_t getMinDim()returns maximum allowed dimensions of data object
size_t getMaxDim()returns minimum number of dimensions of data object
By that implementation of a meta information class you can provide information about references to other instantiated plugins. Every plugin is defined by a bitmask of enumeration ito::tPluginType (defined in addInActuator.h). You can either add a minimum bitmask, that is required, to the HWMeta-instance or you can define an exact name of a plugin, which must be met.
Meta-information for Param of type HWPtr.
Public Functions
- See
- ito::Param
HWMeta(uint32 minType)constructor
creates HWMeta-information struct where you can pass a bitmask which consists of values of the enumeration ito::tPluginType. The plugin reference of the corresponding Param should then only accept plugins, where all bits are set, too.
- See
- ito::Plugin, ito::tPluginType
HWMeta(const char * HWAddInName)constructor
creates HWMeta-information struct where you can pass a specific name of a plugin, which only is allowed by the corresponding plugin-instance.
- See
- ito::Plugin
HWMeta(const HWMeta & cpy)~HWMeta()destructor
uint32 getMinType()returns type-bitmask which is minimally required by plugin-reference. Default 0.
- See
- ito::tPluginType
char * getHWAddInName()returns zero-terminated name of specific plugin-name or NULL if not specified.