ICF 3.0.5.47
Technical documentation of ICF Libraries
imeas::CNumericParamsComp Class Reference

Component implementating imeas::INumericValue interface. More...

#include <CNumericParamsComp.h>

Inheritance diagram for imeas::CNumericParamsComp:
Collaboration diagram for imeas::CNumericParamsComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
typedef CGeneralNumericValue BaseClass2
 
- Public Types inherited from imeas::INumericValue
typedef INumericConstraints::ValueTypeId ValueTypeId
 
- 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 Member Functions

const INumericConstraintsGetNumericConstraints () const override
 Get parameter constraints describing possible parameter values.
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context.
 
 CComponentBase (const CComponentBase &)=delete
 
CComponentBaseoperator= (const CComponentBase &)=delete
 
virtual const ICompositeComponentGetParentComponent (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 IComponentContextGetComponentContext () 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 imeas::CGeneralNumericValue
void RemoveComponentValue (ValueTypeId valueTypeId)
 
void RemoveAllValues ()
 
bool IsValueTypeSupported (ValueTypeId valueTypeId, bool editableOnly=false) const override
 Check if the given value type (or value component) is supported.
 
double GetComponentValue (ValueTypeId valueTypeId) const override
 Get access to component value of the given type.
 
bool SetComponentValue (ValueTypeId valueTypeId, double value) override
 Set component value of the given type.
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
bool CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
std::unique_ptr< istd::IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const override
 Make a copy of this object.
 
bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS) override
 Reset data to its default state.
 
- Public Member Functions inherited from imeas::INumericValue
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data.
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations.
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object.
 
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.
 

Protected Member Functions

void OnUpdate (const istd::IChangeable::ChangeSet &changeSet) override
 Called on update of observed model.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active.
 
virtual const IRealComponentStaticInfoGetComponentStaticInfo () 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 imod::CSingleModelObserverBase
void SetModelPtr (imod::IModel *modelPtr)
 Set internal model pointer to specified value.
 
 CSingleModelObserverBase ()
 
virtual ~CSingleModelObserverBase ()
 
imod::IModelGetObservedModel () const
 Get access to observed model.
 
imod::IModelGetModelPtr () const
 Get access to observed model.
 
void EnsureModelDetached ()
 Make sure this observer is detached.
 
void SetObservedIds (const istd::IChangeable::ChangeSet &changeMask)
 Set list of ID's beeing observed.
 
bool IsModelAttached (const imod::IModel *modelPtr=nullptr) const override
 Check if specified model is attached.
 
bool OnModelAttached (imod::IModel *modelPtr, istd::IChangeable::ChangeSet &changeMask) override
 This call back function will be called, if an observable object is about to be attached.
 
bool OnModelDetached (imod::IModel *modelPtr) override
 This call back function will be called, if an observable object is about to be detached.
 
void BeforeModelChange (imod::IModel *modelPtr) override
 This function will be called before update of the observer contents occures.
 
void AfterModelChange (imod::IModel *modelPtr, const istd::IChangeable::ChangeSet &changeSet) override
 This function will be called after update of the observer contents occures.
 
- Protected Member Functions inherited from imod::IObserver

Additional Inherited Members

- 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.
 
- Static Public Attributes inherited from imeas::INumericValue
static const ValueTypeId VTI_WEIGHT
 Weight of some value This value should be normalized to range [0, 1].
 
static const ValueTypeId VTI_POSITION_X
 Value of position X.
 
static const ValueTypeId VTI_POSITION_Y
 Value of position Y.
 
static const ValueTypeId VTI_RADIUS
 Value of radius.
 
static const ValueTypeId VTI_OFFSET
 
static const ValueTypeId VTI_SCALE
 Scaling factor.
 
static const ValueTypeId VTI_SCALE_Y
 Scaling factor for Y axis.
 
static const ValueTypeId VTI_ANGLE
 Angle in radian.
 
static const ValueTypeId VTI_ALPHA
 Alpha value (proportion).
 
static const ValueTypeId VTI_LENGTH
 Length or distance.
 
static const ValueTypeId VTI_2D_LINE_X1
 
static const ValueTypeId VTI_2D_LINE_Y1
 
static const ValueTypeId VTI_2D_LINE_X2
 
static const ValueTypeId VTI_2D_LINE_Y2
 
static const ValueTypeId VTI_2D_TRANSFORM_M11
 
static const ValueTypeId VTI_2D_TRANSFORM_M12
 
static const ValueTypeId VTI_2D_TRANSFORM_M13
 
static const ValueTypeId VTI_2D_TRANSFORM_M21
 
static const ValueTypeId VTI_2D_TRANSFORM_M22
 
static const ValueTypeId VTI_2D_TRANSFORM_M23
 
static const ValueTypeId VTI_HSV_H
 
static const ValueTypeId VTI_HSV_S
 
static const ValueTypeId VTI_HSV_V
 
static const ValueTypeId VTI_POSITION_TOLERANCE
 
static const ValueTypeId VTI_VALUE_TOLERANCE
 
static const ValueTypeId VTI_THRESHOLD
 
static const ValueTypeId VTI_COUNT
 
static const ValueTypeId VTI_GRID_SIZE
 
static const ValueTypeId VTI_CELL_SIZE
 
static const ValueTypeId VTI_RGB_R
 
static const ValueTypeId VTI_RGB_G
 
static const ValueTypeId VTI_RGB_B
 
- Protected Types inherited from imeas::CGeneralNumericValue
typedef std::map< imeas::INumericValue::ValueTypeId, double > ComponentsMap
 
- Protected Types inherited from imod::CSingleModelObserverBase
typedef imod::IModel ModelType
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 
- Protected Attributes inherited from imeas::CGeneralNumericValue
ComponentsMap m_componentsMap
 

Detailed Description

Component implementating imeas::INumericValue interface.

All parameter constraints can be defined directly or can use external implementation.

Definition at line 27 of file CNumericParamsComp.h.

Member Typedef Documentation

◆ BaseClass

◆ BaseClass2

Member Function Documentation

◆ GetNumericConstraints()

const INumericConstraints & imeas::CNumericParamsComp::GetNumericConstraints ( ) const
overridevirtual

Get parameter constraints describing possible parameter values.

Reimplemented from imeas::CGeneralNumericValue.

◆ OnComponentCreated()

void imeas::CNumericParamsComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnComponentDestroyed()

void imeas::CNumericParamsComp::OnComponentDestroyed ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ OnUpdate()

void imeas::CNumericParamsComp::OnUpdate ( const istd::IChangeable::ChangeSet & changeSet)
overrideprotectedvirtual

Called on update of observed model.

This method is designed to be overload by derrived classes.

Reimplemented from imod::CSingleModelObserverBase.


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

© Witold Gantzke and Kirill Lepskiy