ACF $AcfVersion:0$
Public Member Functions | List of all members
imath::CGeneralUnitInfo Class Reference

General implementation of the IUnitInfo interface. More...

#include <CGeneralUnitInfo.h>

Inheritance diagram for imath::CGeneralUnitInfo:
imath::IUnitInfo iser::ISerializable istd::IChangeable istd::IChangeable istd::IPolymorphic istd::IPolymorphic

Public Member Functions

 CGeneralUnitInfo (int type=UT_UNKNOWN, const QString &name="", double displayMultFactor=1.0, const istd::CRange &range=istd::CRange::GetInvalid(), const imath::IDoubleManip *valueManipPtr=NULL)
 
void SetUnitType (int type)
 
void SetUnitName (const QString &name)
 
void SetDisplayMultiplicationFactor (double factor)
 
void SetValueRange (const istd::CRange &range)
 
virtual bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
virtual int GetUnitType () const override
 Get type of unit.
 
virtual QString GetUnitName () const override
 Get name of unit.
 
virtual double GetDisplayMultiplicationFactor () const override
 Get multiplication factor used to calculate user input values.
 
virtual istd::CRange GetValueRange () const override
 Get range of possible values.
 
virtual const imath::IDoubleManipGetValueManip () const override
 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::IChangeableCloneMe (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 ()
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 

Additional Inherited Members

- Public Types inherited from imath::IUnitInfo
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
 
- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes.
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set.
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set.
 
static const ChangeSetGetDelegatedChanges ()
 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

General implementation of the IUnitInfo interface.

Definition at line 17 of file CGeneralUnitInfo.h.

Constructor & Destructor Documentation

◆ CGeneralUnitInfo()

imath::CGeneralUnitInfo::CGeneralUnitInfo ( int  type = UT_UNKNOWN,
const QString &  name = "",
double  displayMultFactor = 1.0,
const istd::CRange range = istd::CRange::GetInvalid(),
const imath::IDoubleManip valueManipPtr = NULL 
)

Member Function Documentation

◆ GetDisplayMultiplicationFactor()

virtual double imath::CGeneralUnitInfo::GetDisplayMultiplicationFactor ( ) const
overridevirtual

Get multiplication factor used to calculate user input values.

Implements imath::IUnitInfo.

◆ GetUnitName()

virtual QString imath::CGeneralUnitInfo::GetUnitName ( ) const
overridevirtual

Get name of unit.

Implements imath::IUnitInfo.

◆ GetUnitType()

virtual int imath::CGeneralUnitInfo::GetUnitType ( ) const
overridevirtual

Get type of unit.

Implements imath::IUnitInfo.

◆ GetValueManip()

virtual const imath::IDoubleManip & imath::CGeneralUnitInfo::GetValueManip ( ) const
overridevirtual

Return number manipulator object for numeric value.

Implements imath::IUnitInfo.

◆ GetValueRange()

virtual istd::CRange imath::CGeneralUnitInfo::GetValueRange ( ) const
overridevirtual

Get range of possible values.

If invalid range is returned, there is no restrictions.

Implements imath::IUnitInfo.

◆ Serialize()

virtual bool imath::CGeneralUnitInfo::Serialize ( iser::IArchive archive)
overridevirtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See also
iser::IArchive

Implements iser::ISerializable.

◆ SetDisplayMultiplicationFactor()

void imath::CGeneralUnitInfo::SetDisplayMultiplicationFactor ( double  factor)

◆ SetUnitName()

void imath::CGeneralUnitInfo::SetUnitName ( const QString &  name)

◆ SetUnitType()

void imath::CGeneralUnitInfo::SetUnitType ( int  type)

◆ SetValueRange()

void imath::CGeneralUnitInfo::SetValueRange ( const istd::CRange range)

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