itom
4.1.0
|
Meta-information for Param of type IntArrayMeta that represent a range [minVal, maxVal]. More...
#include <paramMeta.h>
Public Member Functions | |
RangeMeta (int32 minVal, int32 maxVal, int32 stepSize=1, ito::ByteArray category=ito::ByteArray()) | |
RangeMeta (int32 minVal, int32 maxVal, int32 stepSize, size_t sizeMin, size_t sizeMax, size_t sizeStep=1, ito::ByteArray category=ito::ByteArray()) | |
Public Member Functions inherited from ito::IntervalMeta | |
IntervalMeta (int32 minVal, int32 maxVal, int32 stepSize=1, ito::ByteArray category=ito::ByteArray()) | |
IntervalMeta (int32 minVal, int32 maxVal, int32 stepSize, int32 sizeMin, int32 sizeMax, int32 intervalStep=1, ito::ByteArray category=ito::ByteArray()) | |
int | getSizeMin () const |
returns minimum size of interval or range | |
int | getSizeMax () const |
returns maximum size of interval or range | |
int | getSizeStepSize () const |
returns step size of size of interval or range | |
bool | isIntervalNotRange () const |
void | setIntervalMin (int32 val) |
sets the minimum size of the interval (= max-min) More... | |
void | setIntervalMax (int32 val) |
sets the maximum size of the interval (= max-min) More... | |
void | setIntervalStep (int32 val) |
sets the step size of the size of the interval (= max-min) More... | |
virtual bool | operator== (const ParamMeta &other) const |
Public Member Functions inherited from ito::IntMeta | |
IntMeta (int32 minVal, int32 maxVal, int32 stepSize=1, ito::ByteArray category=ito::ByteArray()) | |
constructor with minimum and maximum value as well as optional step size (default: 1) | |
int32 | getMin () const |
returns minimum value | |
int32 | getMax () const |
returns maximum value | |
int32 | 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 behaviour) |
sets display representation | |
void | setMin (int32 val) |
sets the minimum value More... | |
void | setMax (int32 val) |
sets the maximum value More... | |
void | setStepSize (int32 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 |
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::IntMeta | |
static IntMeta * | all (ito::ByteArray category=ito::ByteArray()) |
returns a new instance of IntMeta, where the min and max are set to the full range available for integers. The caller has to take care of memory. | |
Protected Attributes inherited from ito::IntervalMeta | |
int32 | m_sizeMin |
int32 | m_sizeMax |
int32 | m_sizeStep |
bool | m_isIntervalNotRange |
this flag describes if this object is an interval where its interval/range is (end-begin) or a range with (1+end-begin) | |
Protected Attributes inherited from ito::ParamMeta | |
MetaRtti | m_type |
ito::ByteArray | m_category |
optional category name of this parameter | |
Meta-information for Param of type IntArrayMeta that represent a range [minVal, maxVal].
An object of this class can be used to parametrize a parameter whose type is ito::ParamBase::IntArray. This meta information class indicates that the corresponding integer array parameter is interpreted as a range, hence, only an array consisting of two values is accepted. The size of the interval is defined by the difference (1 + 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: 1).
An example for a range might be a one dimension (vertical or horizontal) of a ROI (region of interest) of a camera, where the range determines the first and last pixel value inside of the ROI, such that the total size is the difference between both limits + 1.
The range object is defined by its first and last value, that are both inside of the range, hence the size of the range is (1+last-first). This is the difference to IntervalMeta, where the size of the interval is last-first only.