Public Types | Public Member Functions | List of all members
imath::IUnitInfo Class Referenceabstract

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

#include <IUnitInfo.h>

Inheritance diagram for imath::IUnitInfo:
istd::IPolymorphic imath::CGeneralUnitInfo

Public Types

enum  UnitType {
  UT_UNKNOWN, UT_PHYSICAL, UT_TECHNICAL, UT_RELATIVE,
  UT_COUNTER
}
 General type of unit. More...
 

Public Member Functions

virtual int GetUnitType () const =0
 Get type of unit. More...
 
virtual QString GetUnitName () const =0
 Get name of unit. More...
 
virtual double GetDisplayMultiplicationFactor () const =0
 Get multiplication factor used to calculate user input values. More...
 
virtual istd::CRange GetValueRange () const =0
 Get range of possible values. More...
 
virtual const imath::IDoubleManipGetValueManip () const =0
 Return number manipulator object for numeric value. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Detailed Description

Common interface to get information about a measurement unit.

Definition at line 21 of file IUnitInfo.h.

Member Enumeration Documentation

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

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

Get multiplication factor used to calculate user input values.

Implemented in imath::CGeneralUnitInfo.

virtual QString imath::IUnitInfo::GetUnitName ( ) const
pure virtual
virtual int imath::IUnitInfo::GetUnitType ( ) const
pure virtual

Get type of unit.

Implemented in imath::CGeneralUnitInfo.

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

Return number manipulator object for numeric value.

Implemented in imath::CGeneralUnitInfo.

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:

© 2007-2017 Witold Gantzke and Kirill Lepskiy