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

meta-information for Param of type Char. More...

#include <paramMeta.h>

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

Public Member Functions

 CharMeta (char minVal, char maxVal, char stepSize=1, ito::ByteArray category=ito::ByteArray())
 
 CharMeta (const CharMeta &copy)
 
CharMetaoperator= (const CharMeta &rhs)
 
virtual bool operator== (const ParamMeta &other) const
 
char getMin () const
 returns maximum value
 
char getMax () const
 returns step size
 
char getStepSize () const
 returns unit
 
ito::ByteArray getUnit () const
 sets unit string of this parameter
 
void setUnit (const ito::ByteArray &unit)
 returns display representation
 
ParamMeta::tRepresentation getRepresentation () const
 sets display representation
 
void setRepresentation (ParamMeta::tRepresentation representation)
 
void setMin (char val)
 sets the minimum value
 
void setMax (char val)
 sets the maximum value
 
void setStepSize (char val)
 sets the step size
 
- 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
 

Static Public Member Functions

static CharMetaall (ito::ByteArray category=ito::ByteArray())
 returns minimum value
 

Private Attributes

char m_minVal
 
char m_maxVal
 
char m_stepSize
 
ito::ByteArray m_unit
 unit of value, e.g. 'mm', ...
 
ParamMeta::tRepresentation m_representation
 hint for display representation in GUI widget
 

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 , 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 Char.

An object of this class can be used to parametrize a parameter whose type is ito::ParamBase::Char. If set, the given char number can be limited with respect to given minimum and maximum values as well as an optional step size (default: 1).

See also
ito::Param, ito::ParamMeta

Constructor & Destructor Documentation

◆ CharMeta()

ito::CharMeta::CharMeta ( char minVal,
char maxVal,
char stepSize = 1,
ito::ByteArray category = ito::ByteArray() )
explicit

< constructor with minimum and maximum value as well as optional step size (default: 1)

Member Function Documentation

◆ operator==()

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

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.

Reimplemented from ito::ParamMeta.

Reimplemented in ito::CharArrayMeta.

◆ setMax()

void ito::CharMeta::setMax ( char val)

sets the maximum value

Parameters
valis the new maximum value, if this is smaller than the current minimum value, the minimum value is changed to val, too

◆ setMin()

void ito::CharMeta::setMin ( char val)

sets the minimum value

Parameters
valis the new minimum value, if this is bigger than the current maximum value, the maximum value is changed to val, too

◆ setStepSize()

void ito::CharMeta::setStepSize ( char val)

sets the step size

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

◆ setUnit()

void ito::CharMeta::setUnit ( const ito::ByteArray & unit)

returns display representation

< sets unit string of this parameter


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