imath::IUnitInfo Class Reference

Common interface to get information about a measurement unit. More...

#include <IUnitInfo.h>

Inheritance diagram for imath::IUnitInfo:

Public Types
enum	UnitType {   UT_UNKNOWN , UT_PHYSICAL , UT_TECHNICAL , UT_RELATIVE ,   UT_COUNTER }
	General type of unit. More...
Public Types inherited from istd::IChangeable
enum	ChangeFlags {   CF_ACF_INTERNAL = 0 , CF_ALL_DATA , CF_ANY , CF_DESTROYING ,   CF_DELEGATED , CF_NO_UNDO }
	Data model change notification flags. More...
enum	SupportedOperations {   SO_NONE = 0 , SO_OBSERVE = 1 << 0 , SO_COPY = 1 << 1 , SO_CLONE = 1 << 2 ,   SO_COMPARE = 1 << 3 , SO_RESET = 1 << 4 }
	Flags for supported operations. More...
enum	CompatibilityMode { CM_STRICT , CM_WITHOUT_REFS , CM_WITH_REFS , CM_CONVERT }
	Control how relationship betweeen objects are interpreted. More...
typedef QMultiMap< QByteArray, QVariant >	ChangeInfoMap

Public Member Functions
virtual int	GetUnitType () const =0
	Get type of unit.
virtual QString	GetUnitName () const =0
	Get name of unit.
virtual double	GetDisplayMultiplicationFactor () const =0
	Get multiplication factor used to calculate user input values.
virtual istd::CRange	GetValueRange () const =0
	Get range of possible values.
virtual const imath::IDoubleManip &	GetValueManip () const =0
	Return number manipulator object for numeric value.
Public Member Functions inherited from istd::IChangeable
virtual int	GetSupportedOperations () const
	Get set of flags for supported operations.
virtual bool	CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
	Copy this object from another one.
virtual bool	IsEqual (const IChangeable &object) const
	Compare this object with another object.
virtual istd::TUniqueInterfacePtr< istd::IChangeable >	CloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
	Make a copy of this object.
virtual bool	ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
	Reset data to its default state.
virtual void	BeginChanges (const ChangeSet &changeSet)
	Starts the change transaction.
virtual void	EndChanges (const ChangeSet &changeSet)
	Ends the change transaction.
virtual void	BeginChangeGroup (const ChangeSet &changeSet)
	Starts group of changes.
virtual void	EndChangeGroup (const ChangeSet &changeSet)
	Ends group of changes.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Static Public Member Functions inherited from istd::IChangeable
static const ChangeSet &	GetNoChanges ()
	Get empty set of changes.
static const ChangeSet &	GetAnyChange ()
	Get anonymous change set.
static const ChangeSet &	GetAllChanges ()
	Get anonymous change set.
static const ChangeSet &	GetDelegatedChanges ()
	Get delegated change set.
Protected Member Functions inherited from istd::IChangeable
virtual void	OnBeginChanges ()
	Callback function for begin change event.
virtual void	OnEndChanges (const ChangeSet &changeSet)
	Callback function for end change event.

Detailed Description

Common interface to get information about a measurement unit.

Definition at line 21 of file IUnitInfo.h.

Member Enumeration Documentation

UnitType

enum imath::IUnitInfo::UnitType

General type of unit.

Enumerator
UT_UNKNOWN	Unit type is unknown.
UT_PHYSICAL	Physical unit like volt or amper.
UT_TECHNICAL	Technical unit without physical dimension like pixel.
UT_RELATIVE	Unit relative to something others (for example %).
UT_COUNTER	Integer number counter, it represents number of occurence of something.

Definition at line 27 of file IUnitInfo.h.

Member Function Documentation

GetDisplayMultiplicationFactor()

virtual double imath::IUnitInfo::GetDisplayMultiplicationFactor ( ) const

pure virtual

Get multiplication factor used to calculate user input values.

Implemented in imath::CGeneralUnitInfo.

GetUnitName()

virtual QString imath::IUnitInfo::GetUnitName ( ) const

pure virtual

Get name of unit.

Implemented in imath::CGeneralUnitInfo.

Referenced by iqt2d::TShapeParamsGuiCompBase< Ui, Shape, ShapeModel >::GetUnitName().

GetUnitType()

virtual int imath::IUnitInfo::GetUnitType ( ) const

pure virtual

Get type of unit.

Implemented in imath::CGeneralUnitInfo.

GetValueManip()

virtual const imath::IDoubleManip & imath::IUnitInfo::GetValueManip ( ) const

pure virtual

Return number manipulator object for numeric value.

Implemented in imath::CGeneralUnitInfo.

GetValueRange()

virtual istd::CRange imath::IUnitInfo::GetValueRange ( ) const

pure virtual

Get range of possible values.

If invalid range is returned, there is no restrictions.

Implemented in imath::CGeneralUnitInfo.

---

The documentation for this class was generated from the following file:

• Acf/Include/imath/IUnitInfo.h