itom  4.1.0
ito::CharArrayMeta Class Reference

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

#include <paramMeta.h>

Inheritance diagram for ito::CharArrayMeta:
ito::CharMeta ito::ParamMeta

Public Member Functions

 CharArrayMeta (char minVal, char maxVal, char stepSize=1, ito::ByteArray category=ito::ByteArray())
 
 CharArrayMeta (char minVal, char maxVal, char stepSize, size_t numMin, size_t numMax, size_t numStepSize=1, ito::ByteArray category=ito::ByteArray())
 
size_t getNumMin () const
 returns minimum number of values
 
size_t getNumMax () const
 returns maximum number of values
 
size_t getNumStepSize () const
 returns step size of number of values
 
void setNumMin (size_t val)
 sets the minimum number of values More...
 
void setNumMax (size_t val)
 sets the maximum number of values More...
 
void setNumStepSize (size_t val)
 sets the step size of the number of values More...
 
virtual bool operator== (const ParamMeta &other) const
 
- Public Member Functions inherited from ito::CharMeta
 CharMeta (char minVal, char maxVal, char stepSize=1, ito::ByteArray category=ito::ByteArray())
 constructor with minimum and maximum value More...
 
char getMin () const
 returns minimum value
 
char getMax () const
 returns maximum value
 
char getStepSize () const
 returns step size
 
ito::ByteArray getUnit () const
 returns unit
 
void setUnit (const ito::ByteArray &unit)
 sets unit string of this parameter
 
ParamMeta::tRepresentation getRepresentation () const
 returns display representation
 
void setRepresentation (ParamMeta::tRepresentation representation)
 sets display representation
 
void setMin (char val)
 sets the minimum value More...
 
void setMax (char val)
 sets the maximum value More...
 
void setStepSize (char val)
 sets the step size More...
 
- Public Member Functions inherited from ito::ParamMeta
 ParamMeta (ito::ByteArray category=ito::ByteArray())
 default constructor with an unknown meta information type
 
 ParamMeta (MetaRtti type, ito::ByteArray category=ito::ByteArray())
 constructor used by derived classes to indicate their real type
 
virtual ~ParamMeta ()
 destructor
 
MetaRtti getType () const
 returns runtime type information value
 
ito::ByteArray getCategory () const
 returns category name of this parameter (default: empty ByteArray)
 
void setCategory (const ito::ByteArray &category)
 
bool operator!= (const ParamMeta &other) const
 

Private Attributes

size_t m_numMin
 
size_t m_numMax
 
size_t m_numStep
 

Additional Inherited Members

- 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
}
 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...
 
- Static Public Member Functions inherited from ito::CharMeta
static CharMetaall (ito::ByteArray category=ito::ByteArray())
 returns a new instance of CharMeta, where the min and max are set to the full range available for char. The caller has to take care of memory.
 
- 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 CharArrayMeta.

Meta-information for Param of type IntArrayMeta.

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

See also
ito::Param, ito::ParamMeta, ito::CharMeta

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

See also
ito::Param, ito::ParamMeta, ito::IntArray

Member Function Documentation

void ito::CharArrayMeta::setNumMax ( size_t  val)

sets the maximum number of values

Parameters
valis the new maximum value, if this is smaller than the current minimum value, the minimum value is changed to val, too
void ito::CharArrayMeta::setNumMin ( size_t  val)

sets the minimum number of values

Parameters
valis the new minimum value, if this is bigger than the current maximum value, the maximum value is changed to val, too
void ito::CharArrayMeta::setNumStepSize ( size_t  val)

sets the step size of the number of values

Parameters
valis the new step size, hence only discrete values [minVal, minVal+stepSize, minVal+2*stepSize...,maxVal] are allowed

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