itom 2.0.0
ito::IntMeta Class Reference

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

#include <paramMeta.h>

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

List of all members.

Public Member Functions

 IntMeta (int minVal, int maxVal, int stepSize=1)
 constructor with minimum and maximum value as well as optional step size (default: 1)
int getMin () const
 returns minimum value
int getMax () const
 returns maximum value
int getStepSize () const
 returns step size
void setMin (int val)
 sets the minimum value
void setMax (int val)
 sets the maximum value
void setStepSize (int val)
 sets the step size

Static Public Member Functions

static IntMetaall ()
 returns a new instance of IntMeta, where the min and max are set to the full range available for integers.

Private Attributes

int m_minVal
int m_maxVal
int m_stepSize

Detailed Description

Meta-information for Param of type Int.

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

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

Member Function Documentation

void ito::IntMeta::setMax ( int  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::IntMeta::setMin ( int  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::IntMeta::setStepSize ( int  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 Friends