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

#include <paramMeta.h>

Inheritance diagram for ito::DoubleIntervalMeta:

Public Member Functions
	DoubleIntervalMeta (float64 minVal, float64 maxVal, float64 stepSize=0.0, ito::ByteArray category=ito::ByteArray())

	DoubleIntervalMeta (float64 minVal, float64 maxVal, float64 stepSize, float64 sizeMin, float64 sizeMax, float64 sizeStep=0.0, ito::ByteArray category=ito::ByteArray())

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) More...

void	setSizeMax (float64 val)
	sets the maximum size of the interval (= max-min) More...

void	setSizeStep (float64 val)
	sets the step size of the size of the interval (= max-min) More...

virtual bool	operator== (const ParamMeta &other) const

Public Member Functions inherited from ito::DoubleMeta
	DoubleMeta (float64 minVal, float64 maxVal, float64 stepSize=0.0, ito::ByteArray category=ito::ByteArray())
	constructor with minimum and maximum value

float64	getMin () const
	returns minimum value

float64	getMax () const
	returns maximum value

float64	getStepSize () const
	returns step size

ito::ByteArray	getUnit () const
	returns unit

void	setUnit (const ito::ByteArray &unit)
	sets unit string of this parameter

int	getDisplayPrecision () const
	returns display precision

void	setDisplayPrecision (int displayPrecision)
	sets display precision

DoubleMeta::tDisplayNotation	getDisplayNotation () const
	returns display notation

void	setDisplayNotation (DoubleMeta::tDisplayNotation displayNotation)
	sets display notation

ParamMeta::tRepresentation	getRepresentation () const
	returns display representation

void	setRepresentation (ParamMeta::tRepresentation representation)
	sets display representation

void	setMin (float64 val)
	sets the minimum value More...

void	setMax (float64 val)
	sets the maximum value More...

void	setStepSize (float64 val)
	sets the step size More...

Public Member Functions inherited from ito::ParamMeta
	ParamMeta (ito::ByteArray category=ito::ByteArray())
	default constructor with an unknown meta information type

	ParamMeta (MetaRtti type, ito::ByteArray category=ito::ByteArray())
	constructor used by derived classes to indicate their real type

virtual	~ParamMeta ()
	destructor

MetaRtti	getType () const
	returns runtime type information value

ito::ByteArray	getCategory () const
	returns category name of this parameter (default: empty ByteArray)

void	setCategory (const ito::ByteArray &category)

bool	operator!= (const ParamMeta &other) const

Private Attributes
float64	m_sizeMin

float64	m_sizeMax

float64	m_sizeStep

Additional Inherited Members
Public Types inherited from ito::DoubleMeta
enum	tDisplayNotation { Automatic, Fixed, Scientific }
	Display notation style if the related parameters is displayed in any widget. More...

Public Types inherited from ito::ParamMeta
enum	MetaRtti { rttiUnknown = 0, rttiCharMeta = 1, rttiIntMeta = 2, rttiDoubleMeta = 3, rttiStringMeta = 4, rttiHWMeta = 5, rttiDObjMeta = 6, rttiIntArrayMeta = 7, rttiDoubleArrayMeta = 8, rttiCharArrayMeta = 9, rttiIntervalMeta = 10, rttiDoubleIntervalMeta = 11, rttiRangeMeta = 12, rttiRectMeta = 13 }
	Runtime type information. More...

enum	tRepresentation { Linear = 0x0001, Logarithmic = 0x0002, Boolean = 0x0004, PureNumber = 0x0008, HexNumber = 0x0010, IPV4Address = 0x0020, MACAddress = 0x0040, UnknownRepresentation = 0x0080 }
	The representation of number types indicates the type of widget that is suited best to display and change the value. More...

Static Public Member Functions inherited from ito::DoubleMeta
static DoubleMeta *	all (ito::ByteArray category=ito::ByteArray())
	returns a new instance of DoubleMeta, where the min and max are set to the full range available for double. The caller has to take care of memory.

Protected Attributes inherited from ito::ParamMeta
MetaRtti	m_type

ito::ByteArray	m_category
	optional category name of this parameter

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

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::DoubleIntervalMeta::setSizeMin ( float64 val )

sets the minimum size of the interval (= max-min)

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::DoubleIntervalMeta::setSizeStep ( float64 val )

sets the step size of the size of the interval (= max-min)

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:/itom/sources/itom/common/paramMeta.h
D:/itom/sources/itom/common/sources/paramMeta.cpp

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation