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

#include <paramMeta.h>

Inheritance diagram for ito::DoubleMeta:

Public Types
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...

Public Member Functions
	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...

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

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

Static Public Member Functions
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.

Private Attributes
float64	m_minVal

float64	m_maxVal

float64	m_stepSize

ito::ByteArray	m_unit
	unit of value, e.g. 'mm', ...

int	m_displayPrecision
	hint for the number of decimal digits that should be shown in any GUI widget, default: 3

tDisplayNotation	m_displayNotation
	indicates how this double number should be rendered (e.g. in GUI widgets)

ParamMeta::tRepresentation	m_representation
	hint for display representation in GUI widget

Additional Inherited Members
Protected Attributes inherited from ito::ParamMeta
MetaRtti	m_type

ito::ByteArray	m_category
	optional category name of this parameter

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 Enumeration Documentation

enum ito::DoubleMeta::tDisplayNotation

Display notation style if the related parameters is displayed in any widget.

Enumerator
Automatic	double number is automatically rendered in any GUI element
Fixed	if possible, the double number should be shown as fixed number, e.g. 1000.00
Scientific	if possible, the double number should be rendered in a scientific notation, e.g. 1.0E3

Member Function Documentation

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

C:/itom/sources/itom/common/paramMeta.h
C:/itom/sources/itom/common/sources/paramMeta.cpp

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Member Function Documentation