![]() |
ICF 3.1.1.10
Technical documentation of ICF Libraries
|
Unit info selection for relative values. More...
#include <CRelativeUnitSelectorComp.h>
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. | |
Definition at line 33 of file CRelativeUnitSelectorComp.h.
Definition at line 35 of file CRelativeUnitSelectorComp.h.
| imeas::CRelativeUnitSelectorComp::CRelativeUnitSelectorComp | ( | ) |
|
overridevirtual |
Get multiplication factor used to calculate user input values.
Implements imath::IUnitInfo.
|
overridevirtual |
Get human readable description for a option with the index index.
Implements iprm::IOptionsList.
|
overridevirtual |
Get option ID.
The option ID must be unique, if flag SCF_SUPPORT_UNIQUE_ID is set.
Implements iprm::IOptionsList.
|
overridevirtual |
Get name of specified option.
Implements iprm::IOptionsList.
|
overridevirtual |
Get number of managed options.
Implements iprm::IOptionsList.
|
overridevirtual |
Get constraints flags.
The flags describes how the constraints object mantainance
Implements iprm::IOptionsList.
|
overridevirtual |
|
overridevirtual |
Get selected index.
Implements iprm::ISelectionParam.
|
overridevirtual |
Get constraints of this parameter.
Constraints describes some additional information about allowed parameter ranges and related informations.
Implements iprm::ISelectionParam.
|
overridevirtual |
Get subselection for specified option.
Please note, that returned options tree belongs to selection data model.
Implements iprm::ISelectionParam.
|
overridevirtual |
Get name of unit.
Implements imath::IUnitInfo.
|
overridevirtual |
Get type of unit.
Implements imath::IUnitInfo.
|
overridevirtual |
Return number manipulator object for numeric value.
Implements imath::IUnitInfo.
|
overridevirtual |
Get range of possible values.
If invalid range is returned, there is no restrictions.
Implements imath::IUnitInfo.
| imeas::CRelativeUnitSelectorComp::I_DECLARE_ENUM | ( | DisplayMode | , |
| DM_NONE | , | ||
| DM_PERCENT | , | ||
| DM_PERMILLE | ) |
|
overridevirtual |
Return true if the option is enabled and can be selected.
Implements iprm::IOptionsList.
|
overrideprotectedvirtual |
Reimplemented from icomp::CComponentBase.
|
overridevirtual |
Load or store state of this object as a archive stream.
Type of operation is depending on archive type.
Implements iser::ISerializable.
|
overridevirtual |
Set index of selected option.
Implements iprm::ISelectionParam.
© Witold Gantzke and Kirill Lepskiy