ICF 3.1.1.10
Technical documentation of ICF Libraries
imeas::CRelativeUnitSelectorComp Class Reference

Unit info selection for relative values. More...

#include <CRelativeUnitSelectorComp.h>

Inheritance diagram for imeas::CRelativeUnitSelectorComp:
Collaboration diagram for imeas::CRelativeUnitSelectorComp:

Public Types

enum  DisplayMode { DM_NONE , DM_PERCENT , DM_PERMILLE , DM_LAST_MODE = DM_PERMILLE }
 
typedef icomp::CComponentBase BaseClass
 
- 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_ICF_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 , SO_CHANGE_LOCK = 1 << 5
}
 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...
 
- Public Types inherited from iprm::ISelectionParam
enum  ChangeFlags { CF_SELECTION_CHANGED = 0x67364be }
 Data model change notification flags. More...
 
enum  { NO_SELECTION = -1 }
 

Public Member Functions

 I_DECLARE_ENUM (DisplayMode, DM_NONE, DM_PERCENT, DM_PERMILLE)
 
 CRelativeUnitSelectorComp ()
 
const iprm::IOptionsList * GetSelectionConstraints () const override
 Get constraints of this parameter.
 
QByteArray GetSelectedOptionId () const override
 Get selected ID.
 
int GetSelectedOptionIndex () const override
 Get selected index.
 
bool SetSelectedOptionIndex (int index) override
 Set index of selected option.
 
iprm::ISelectionParam * GetSubselection (int index) const override
 Get subselection for specified option.
 
int GetOptionsFlags () const override
 Get constraints flags.
 
int GetOptionsCount () const override
 Get number of managed options.
 
QString GetOptionName (int index) const override
 Get name of specified option.
 
QString GetOptionDescription (int index) const override
 Get human readable description for a option with the index index.
 
QByteArray GetOptionId (int index) const override
 Get option ID.
 
bool IsOptionEnabled (int index) const override
 Return true if the option is enabled and can be selected.
 
int GetUnitType () const override
 Get type of unit.
 
QString GetUnitName () const override
 Get name of unit.
 
double GetDisplayMultiplicationFactor () const override
 Get multiplication factor used to calculate user input values.
 
istd::CRange GetValueRange () const override
 Get range of possible values.
 
const imath::IDoubleManip & GetValueManip () const override
 Return number manipulator object for numeric value.
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBase & operator= (const CComponentBase &)=delete
 
virtual const ICompositeComponent * GetParentComponent (bool ownerOnly=false) const
 Get parent of this component.
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface.
 
virtual const IComponentContext * GetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry.
 
virtual void SetComponentContext (const IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component.
 
- Public Member Functions inherited from icomp::IComponent
- Public Member Functions inherited from imath::IUnitInfo
- 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 std::unique_ptr< 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 QMutex * GetChangesLock () const
 Get mutex beeing locked during changes, if available.
 
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 iprm::ISelectionParam
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 

Protected Member Functions

void OnComponentCreated () override
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual void OnComponentDestroyed ()
 
virtual const IRealComponentStaticInfo & GetComponentStaticInfo () const =0
 Get access to static info of this component.
 
- 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.
 
- Protected Member Functions inherited from iprm::IOptionsList

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 Types inherited from iprm::IOptionsList
enum  ChangeFlags { CF_OPTIONS_CHANGED = 0x8263d86 , CF_OPTION_RENAMED }
 Flags for changes related to this interface. More...
 
enum  OptionsFlags { SCF_NONE = 0 , SCF_SUPPORT_UNIQUE_ID = 256 , SFC_DISABLE_ALLOWED = 32 }
 Flags for control constraints behavior. More...
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfo & InitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 
- Static Protected Member Functions inherited from iprm::IOptionsList
static int FindIndexById (const QByteArray &id, const iprm::IOptionsList &list)
 Helper function to find the option index by ID.
 

Detailed Description

Unit info selection for relative values.


Definition at line 26 of file CRelativeUnitSelectorComp.h.

Member Typedef Documentation

◆ BaseClass

Member Enumeration Documentation

◆ DisplayMode

Enumerator
DM_NONE 

No multiplication factor should be used for displaying value.

DM_PERCENT 

Percent should be used for displaying value.

DM_PERMILLE 

Per-mille should be used for displaying value.

DM_LAST_MODE 

Definition at line 35 of file CRelativeUnitSelectorComp.h.

Constructor & Destructor Documentation

◆ CRelativeUnitSelectorComp()

imeas::CRelativeUnitSelectorComp::CRelativeUnitSelectorComp ( )

Member Function Documentation

◆ GetDisplayMultiplicationFactor()

double imeas::CRelativeUnitSelectorComp::GetDisplayMultiplicationFactor ( ) const
overridevirtual

Get multiplication factor used to calculate user input values.

Implements imath::IUnitInfo.

◆ GetOptionDescription()

QString imeas::CRelativeUnitSelectorComp::GetOptionDescription ( int index) const
overridevirtual

Get human readable description for a option with the index index.

Implements iprm::IOptionsList.

◆ GetOptionId()

QByteArray imeas::CRelativeUnitSelectorComp::GetOptionId ( int index) const
overridevirtual

Get option ID.

The option ID must be unique, if flag SCF_SUPPORT_UNIQUE_ID is set.

See also
OptionsFlags

Implements iprm::IOptionsList.

◆ GetOptionName()

QString imeas::CRelativeUnitSelectorComp::GetOptionName ( int index) const
overridevirtual

Get name of specified option.

Implements iprm::IOptionsList.

◆ GetOptionsCount()

int imeas::CRelativeUnitSelectorComp::GetOptionsCount ( ) const
overridevirtual

Get number of managed options.

Implements iprm::IOptionsList.

◆ GetOptionsFlags()

int imeas::CRelativeUnitSelectorComp::GetOptionsFlags ( ) const
overridevirtual

Get constraints flags.

The flags describes how the constraints object mantainance

Implements iprm::IOptionsList.

◆ GetSelectedOptionId()

QByteArray imeas::CRelativeUnitSelectorComp::GetSelectedOptionId ( ) const
overridevirtual

Get selected ID.

Returns
ID of selected option.

Implements iprm::ISelectionParam.

◆ GetSelectedOptionIndex()

int imeas::CRelativeUnitSelectorComp::GetSelectedOptionIndex ( ) const
overridevirtual

Get selected index.

Returns
index of selected option or negative value if no option is selected.

Implements iprm::ISelectionParam.

◆ GetSelectionConstraints()

const iprm::IOptionsList * imeas::CRelativeUnitSelectorComp::GetSelectionConstraints ( ) const
overridevirtual

Get constraints of this parameter.

Constraints describes some additional information about allowed parameter ranges and related informations.

Implements iprm::ISelectionParam.

◆ GetSubselection()

iprm::ISelectionParam * imeas::CRelativeUnitSelectorComp::GetSubselection ( int index) const
overridevirtual

Get subselection for specified option.

Please note, that returned options tree belongs to selection data model.

Implements iprm::ISelectionParam.

◆ GetUnitName()

QString imeas::CRelativeUnitSelectorComp::GetUnitName ( ) const
overridevirtual

Get name of unit.

Implements imath::IUnitInfo.

◆ GetUnitType()

int imeas::CRelativeUnitSelectorComp::GetUnitType ( ) const
overridevirtual

Get type of unit.

Implements imath::IUnitInfo.

◆ GetValueManip()

const imath::IDoubleManip & imeas::CRelativeUnitSelectorComp::GetValueManip ( ) const
overridevirtual

Return number manipulator object for numeric value.

Implements imath::IUnitInfo.

◆ GetValueRange()

istd::CRange imeas::CRelativeUnitSelectorComp::GetValueRange ( ) const
overridevirtual

Get range of possible values.

If invalid range is returned, there is no restrictions.

Implements imath::IUnitInfo.

◆ I_DECLARE_ENUM()

imeas::CRelativeUnitSelectorComp::I_DECLARE_ENUM ( DisplayMode ,
DM_NONE ,
DM_PERCENT ,
DM_PERMILLE  )

◆ IsOptionEnabled()

bool imeas::CRelativeUnitSelectorComp::IsOptionEnabled ( int index) const
overridevirtual

Return true if the option is enabled and can be selected.

Implements iprm::IOptionsList.

◆ OnComponentCreated()

void imeas::CRelativeUnitSelectorComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ Serialize()

bool imeas::CRelativeUnitSelectorComp::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.

◆ SetSelectedOptionIndex()

bool imeas::CRelativeUnitSelectorComp::SetSelectedOptionIndex ( int index)
overridevirtual

Set index of selected option.

Returns
true if selection change was possible.

Implements iprm::ISelectionParam.


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

© Witold Gantzke and Kirill Lepskiy