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

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

#include <paramMeta.h>

Inheritance diagram for ito::DoubleIntervalMeta:
ito::DoubleMeta ito::ParamMeta

Public Member Functions

 DoubleIntervalMeta (float64 minVal, float64 maxVal, float64 stepSize=0.0, ito::ByteArray category=ito::ByteArray())
 
 DoubleIntervalMeta (float64 minVal, float64 maxVal, float64 stepSize, float64 sizeMin, float64 sizeMax, float64 sizeStep=0.0, ito::ByteArray category=ito::ByteArray())
 
 DoubleIntervalMeta (const DoubleIntervalMeta &cpy)
 copy constructor
 
virtual bool operator== (const ParamMeta &other) const
 assignment operator
 
DoubleIntervalMetaoperator= (const DoubleIntervalMeta &rhs)
 returns minimum size of range
 
float64 getSizeMin () const
 returns maximum size of range
 
float64 getSizeMax () const
 returns step size of size of range
 
float64 getSizeStepSize () const
 
void setSizeMin (float64 val)
 sets the minimum size of the interval (= max-min)
 
void setSizeMax (float64 val)
 sets the maximum size of the interval (= max-min)
 
void setSizeStep (float64 val)
 sets the step size of the size of the interval (= max-min)
 
- Public Member Functions inherited from ito::DoubleMeta
 DoubleMeta (float64 minVal, float64 maxVal, float64 stepSize=0.0, ito::ByteArray category=ito::ByteArray())
 constructor with minimum and maximum value
 
 DoubleMeta (const DoubleMeta &copy)
 
DoubleMetaoperator= (const DoubleMeta &rhs)
 
float64 getMin () const
 returns maximum value
 
float64 getMax () const
 returns step size
 
float64 getStepSize () const
 returns unit
 
ito::ByteArray getUnit () const
 sets unit string of this parameter
 
void setUnit (const ito::ByteArray &unit)
 returns display precision
 
int getDisplayPrecision () const
 sets display precision
 
void setDisplayPrecision (int displayPrecision)
 returns display notation
 
DoubleMeta::tDisplayNotation getDisplayNotation () const
 sets display notation
 
void setDisplayNotation (DoubleMeta::tDisplayNotation displayNotation)
 returns display representation
 
ParamMeta::tRepresentation getRepresentation () const
 sets display representation
 
void setRepresentation (ParamMeta::tRepresentation representation)
 
void setMin (float64 val)
 sets the minimum value
 
void setMax (float64 val)
 sets the maximum value
 
void setStepSize (float64 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
 

Private Attributes

float64 m_sizeMin
 
float64 m_sizeMax
 
float64 m_sizeStep
 

Additional Inherited Members

- Public Types inherited from ito::DoubleMeta
enum  tDisplayNotation { Automatic , Fixed , Scientific }
 Display notation style if the related parameters is displayed in any widget. More...
 
- 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...
 
- Static Public Member Functions inherited from ito::DoubleMeta
static DoubleMetaall (ito::ByteArray category=ito::ByteArray())
 returns minimum value
 
- 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 DoubleIntervalMeta.

An object of this class can be used to parametrize a parameter whose type is ito::ParamBase::DoubleArray. This meta information class indicates that the corresponding double array parameter is interpreted as an interval, hence, only an array consisting of two values is accepted. The size of the interval is defined by the difference (value[1] - value[0]). You can restrict this size to a certain minimum and maximum value as well as indicating a specific step size (default: 0.0 -> no step size).

See also
ito::Param, ito::ParamMeta, ito::DoubleMeta

Member Function Documentation

◆ operator=()

DoubleIntervalMeta & ito::DoubleIntervalMeta::operator= ( const DoubleIntervalMeta & rhs)

returns minimum size of range

< assignment operator

◆ operator==()

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

assignment operator

Reimplemented from ito::DoubleMeta.

◆ setSizeMax()

void ito::DoubleIntervalMeta::setSizeMax ( float64 val)

sets the maximum size of the interval (= max-min)

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

◆ setSizeMin()

void ito::DoubleIntervalMeta::setSizeMin ( float64 val)

sets the minimum size of the interval (= max-min)

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

◆ setSizeStep()

void ito::DoubleIntervalMeta::setSizeStep ( float64 val)

sets the step size of the size of the interval (= max-min)

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: