itom 2.0.0
ito::DoubleArrayMeta Class Reference

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

#include <paramMeta.h>

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

List of all members.

Public Member Functions

 DoubleArrayMeta (double minVal, double maxVal, double stepSize=0.0)
 DoubleArrayMeta (double minVal, double maxVal, double stepSize, size_t numMin, size_t numMax, size_t numStepSize=1)
size_t getNumMin () const
 returns minimum number of values
size_t getNumMax () const
 returns maximum number of values
size_t getNumStepSize () const
 returns step size of number of values
void setNumMin (size_t val)
 sets the minimum number of values
void setNumMax (size_t val)
 sets the maximum number of values
void setNumStepSize (size_t val)
 sets the step size of the number of values

Private Attributes

size_t m_numMin
size_t m_numMax
size_t m_numStep

Detailed Description

Meta-information for Param of type DoubleArrayMeta.

An object of this class can be used to parametrize a parameter whose type is ito::ParamBase::DoubleArray. Since this meta information class is derived from ito::DoubleArray, it is possible to restrict each value to the single value contraints of ito::DoubleArray. Furthermore, this class allows restricting the minimum and maximum length of the array as well as the optional step size of the array's length.

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

Member Function Documentation

void ito::DoubleArrayMeta::setNumMax ( size_t  val)

sets the maximum number of values

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::DoubleArrayMeta::setNumMin ( size_t  val)

sets the minimum number of values

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::DoubleArrayMeta::setNumStepSize ( size_t  val)

sets the step size of the number of values

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 Friends