ito::CharMeta Class Reference

meta-information for Param of type Char. More...

#include <paramMeta.h>

Inheritance diagram for ito::CharMeta:

List of all members.

Public Member Functions
	CharMeta (char minVal, char maxVal, char stepSize=1)
	constructor with minimum and maximum value
char	getMin () const
	returns minimum value
char	getMax () const
	returns maximum value
char	getStepSize () const
	returns step size
void	setMin (char val)
	sets the minimum value
void	setMax (char val)
	sets the maximum value
void	setStepSize (char val)
	sets the step size
Static Public Member Functions
static CharMeta *	all ()
	returns a new instance of CharMeta, where the min and max are set to the full range available for char.
Private Attributes
char	m_minVal
char	m_maxVal
char	m_stepSize

---

Detailed Description

meta-information for Param of type Char.

An object of this class can be used to parametrize a parameter whose type is ito::ParamBase::Char. If set, the given char 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

---

Constructor & Destructor Documentation

ito::CharMeta::CharMeta	(	char	minVal,
		char	maxVal,
		char	stepSize = 1
	)		[explicit]

constructor with minimum and maximum value

constructor with minimum and maximum value as well as optional step size (default: 1)

---

Member Function Documentation

void ito::CharMeta::setMax

(

char

val

)

sets the maximum value

Parameters:

val	is the new maximum value, if this is smaller than the current minimum value, the minimum value is changed to val, too

void ito::CharMeta::setMin

(

char

val

)

sets the minimum value

Parameters:

val	is the new minimum value, if this is bigger than the current maximum value, the maximum value is changed to val, too

void ito::CharMeta::setStepSize

(

char

val

)

sets the step size

Parameters:

val	is 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:

• D:/git-itom/sources/itom/common/paramMeta.h
• D:/git-itom/sources/itom/common/sources/paramMeta.cpp