itom 2.0.0
ito::RangeMeta Class Reference

Meta-information for Param of type IntArrayMeta that represent a range [minVal, maxVal]. More...

#include <paramMeta.h>

Inheritance diagram for ito::RangeMeta:
ito::IntervalMeta ito::IntMeta ito::ParamMeta

List of all members.

Public Member Functions

 RangeMeta (int minVal, int maxVal, int stepSize=1)
 RangeMeta (int minVal, int maxVal, int stepSize, int sizeMin, int sizeMax, int sizeStep=1)

Detailed Description

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.

See also:
ito::Param, ito::ParamMeta, ito::IntervalMeta, ito::IntArrayMeta

The documentation for this class was generated from the following files:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends