itom 2.2.1
ito::DoubleMeta Class Reference

Meta-information for ito::Param of type Double. More...

#include <paramMeta.h>

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

List of all members.

Public Member Functions

 DoubleMeta (float64 minVal, float64 maxVal, float64 stepSize=0.0)
 constructor with minimum and maximum value
float64 getMin () const
 returns minimum value
float64 getMax () const
 returns maximum value
float64 getStepSize () const
 returns step size
void setMin (float64 val)
 sets the minimum value
void setMax (float64 val)
 sets the maximum value
void setStepSize (float64 val)
 sets the step size

Static Public Member Functions

static DoubleMetaall ()
 returns a new instance of DoubleMeta, where the min and max are set to the full range available for double.

Private Attributes

float64 m_minVal
float64 m_maxVal
float64 m_stepSize

Detailed Description

Meta-information for ito::Param of type Double.

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

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

Member Function Documentation

void ito::DoubleMeta::setMax ( float64  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
void ito::DoubleMeta::setMin ( float64  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
void ito::DoubleMeta::setStepSize ( float64  val)

sets the step size

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