itom 2.2.1
ito::DoubleIntervalMeta Class Reference

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

#include <paramMeta.h>

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

List of all members.

Public Member Functions

 DoubleIntervalMeta (float64 minVal, float64 maxVal, float64 stepSize=0.0)
 DoubleIntervalMeta (float64 minVal, float64 maxVal, float64 stepSize, float64 sizeMin, float64 sizeMax, float64 sizeStep=0.0)
float64 getSizeMin () const
 returns minimum size of range
float64 getSizeMax () const
 returns maximum size of range
float64 getSizeStepSize () const
 returns step size of size of range
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)

Private Attributes

float64 m_sizeMin
float64 m_sizeMax
float64 m_sizeStep

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

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
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
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:
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Friends