itom
Loading...
Searching...
No Matches
ito::StringListMeta Class Reference

Meta-information for Param of type STringListMeta. More...

#include <paramMeta.h>

Inheritance diagram for ito::StringListMeta:
ito::StringMeta ito::ListMeta ito::ParamMeta

Public Member Functions

 StringListMeta (tType type, size_t numMin, size_t numMax, size_t numStepSize=1, ito::ByteArray category=ito::ByteArray())
 constructor
 
 StringListMeta (tType type, const char *val, size_t numMin, size_t numMax, size_t numStepSize=1, ito::ByteArray category=ito::ByteArray())
 constructor
 
 StringListMeta (tType type, const ito::ByteArray &val, size_t numMin, size_t numMax, size_t numStepSize=1, ito::ByteArray category=ito::ByteArray())
 constructor
 
 StringListMeta (const StringListMeta &cpy)
 copy constructor
 
virtual ~StringListMeta ()
 destructor
 
virtual bool operator== (const ParamMeta &other) const
 assignment operator
 
StringListMetaoperator= (const StringListMeta &rhs)
 < assignment operator
 
- Public Member Functions inherited from ito::StringMeta
 StringMeta (tType type, ito::ByteArray category=ito::ByteArray())
 constructor
 
 StringMeta (tType type, const char *val, ito::ByteArray category=ito::ByteArray())
 constructor
 
 StringMeta (tType type, const ito::ByteArray &val, ito::ByteArray category=ito::ByteArray())
 constructor
 
 StringMeta (const StringMeta &cpy)
 copy constructor
 
virtual ~StringMeta ()
 destructor
 
StringMetaoperator+= (const char *val)
 add another pattern string to the list of patterns.
 
StringMetaoperator= (const StringMeta &rhs)
 
tType getStringType () const
 returns the type how strings in list should be considered.
 
void setStringType (tType type)
 sets the type how strings in pattern list should be considered.
 
int getLen () const
 returns the number of string elements in meta information class.
 
const char * getString (int idx=0) const
 returns string from list at index position or NULL, if index is out of range.
 
bool addItem (const char *val)
 adds another element to the list of patterns.
 
bool addItem (const ito::ByteArray &val)
 adds another element to the list of patterns.
 
void clearItems ()
 clear all elements from the pattern list.
 
- Public Member Functions inherited from ito::ParamMeta
 ParamMeta (ito::ByteArray category=ito::ByteArray())
 constructor used by derived classes to indicate their real type
 
 ParamMeta (MetaRtti type, ito::ByteArray category=ito::ByteArray())
 
 ParamMeta (const ParamMeta &copy)
 
ParamMetaoperator= (const ParamMeta &rhs)
 destructor
 
virtual ~ParamMeta ()
 returns runtime type information value
 
MetaRtti getType () const
 returns category name of this parameter (default: empty ByteArray)
 
ito::ByteArray getCategory () const
 
void setCategory (const ito::ByteArray &category)
 
bool operator!= (const ParamMeta &other) const
 
- Public Member Functions inherited from ito::ListMeta
 ListMeta ()
 < default constructor with an arbitrary list size
 
 ListMeta (size_t numMin, size_t numMax, size_t numStepSize=1)
 destructor
 
virtual ~ListMeta ()
 < destructor
 
virtual bool operator== (const ListMeta &other) const
 returns minimum number of values
 
size_t getNumMin () const
 returns maximum number of values
 
size_t getNumMax () const
 returns step size of number of values
 
size_t getNumStepSize () const
 
void setNumMin (size_t val)
 sets the minimum number of values
 
void setNumMax (size_t val)
 sets the maximum number of values
 
void setNumStepSize (size_t val)
 sets the step size of the number of values
 

Additional Inherited Members

- Public Types inherited from ito::StringMeta
enum  tType { String , Wildcard , RegExp }
 
- Public Types inherited from ito::ParamMeta
enum  MetaRtti {
  rttiUnknown = 0 , rttiCharMeta = 1 , rttiIntMeta = 2 , rttiDoubleMeta = 3 ,
  rttiStringMeta = 4 , rttiHWMeta = 5 , rttiDObjMeta = 6 , rttiIntArrayMeta = 7 ,
  rttiDoubleArrayMeta = 8 , rttiCharArrayMeta = 9 , rttiIntervalMeta = 10 , rttiDoubleIntervalMeta = 11 ,
  rttiRangeMeta = 12 , rttiRectMeta = 13 , rttiStringListMeta = 14
}
 Runtime type information. More...
 
enum  tRepresentation {
  Linear = 0x0001 , Logarithmic = 0x0002 , Boolean = 0x0004 , PureNumber = 0x0008 ,
  HexNumber = 0x0010 , IPV4Address = 0x0020 , MACAddress = 0x0040 , UnknownRepresentation = 0x0080
}
 The representation of number types indicates the type of widget that is suited best to display and change the value. More...
 
- Protected Attributes inherited from ito::ParamMeta
MetaRtti m_type
 
ito::ByteArray m_category
 optional category name of this parameter
 

Detailed Description

Meta-information for Param of type STringListMeta.

An object of this class can be used to parametrize a parameter whose type is ito::ParamBase::StringListMeta. Since this meta information class is derived from ito::StringMeta, it is possible to restrict each value to the single value constraints of ito::StringMeta. Furthermore, this class allows restricting the minimum and maximum length of the list as well as the optional step size of the list's length.

See also
ito::Param, ito::ParamMeta, ito::StringMeta

Constructor & Destructor Documentation

◆ StringListMeta() [1/3]

ito::StringListMeta::StringListMeta ( tType type,
size_t numMin,
size_t numMax,
size_t numStepSize = 1,
ito::ByteArray category = ito::ByteArray() )
explicit

constructor

Returns a meta information class for string list types.

Parameters
typeindicates how the string elements should be considered
numMinis the minimum number of values in the list
numMaxis the maximum number of values in the list
numStepSizeis the step size of the number of values in the list
See also
tType

◆ StringListMeta() [2/3]

ito::StringListMeta::StringListMeta ( tType type,
const char * val,
size_t numMin,
size_t numMax,
size_t numStepSize = 1,
ito::ByteArray category = ito::ByteArray() )
explicit

constructor

Returns a meta information class for string list types.

Parameters
typeindicates how the string elements should be considered
valadds a first string to the element list
numMinis the minimum number of values in the list
numMaxis the maximum number of values in the list
numStepSizeis the step size of the number of values in the list
See also
tType

◆ StringListMeta() [3/3]

ito::StringListMeta::StringListMeta ( tType type,
const ito::ByteArray & val,
size_t numMin,
size_t numMax,
size_t numStepSize = 1,
ito::ByteArray category = ito::ByteArray() )
explicit

constructor

Returns a meta information class for string list types.

Parameters
typeindicates how the string elements should be considered
valadds a first string to the element list
numMinis the minimum number of values in the list
numMaxis the maximum number of values in the list
numStepSizeis the step size of the number of values in the list
See also
tType

Member Function Documentation

◆ operator==()

bool ito::StringListMeta::operator== ( const ParamMeta & other) const
virtual

assignment operator

Reimplemented from ito::StringMeta.


The documentation for this class was generated from the following files: