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

Basic implementation of component of linear adjust parameters. More...

#include <CLinearAdjustParamsComp.h>

Inheritance diagram for imeas::CLinearAdjustParamsComp:
Collaboration diagram for imeas::CLinearAdjustParamsComp:

Public Types

typedef icomp::CComponentBase BaseClass
 
- 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 imeas::INumericValue
typedef INumericConstraints::ValueTypeId ValueTypeId
 

Public Member Functions

 CLinearAdjustParamsComp ()
 
const ILinearAdjustConstraintsGetAdjustConstraints () const override
 Get access to constraints object.
 
double GetScaleFactor () const override
 Get value of scale factor.
 
void SetScaleFactor (double scale) override
 Set value of scale factor.
 
double GetOffsetFactor () const override
 Get value of offset factor.
 
void SetOffsetFactor (double offset) override
 Set value of offset factor.
 
bool IsValueTypeSupported (ValueTypeId valueTypeId, bool editableOnly=false) const override
 Check if the given value type (or value component) is supported.
 
const INumericConstraintsGetNumericConstraints () const override
 Get parameter constraints describing possible parameter values.
 
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.
 
- 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::ILinearAdjustParams
- 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 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< 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 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 imeas::INumericValue

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 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.
 

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
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const IRealComponentStaticInfoInitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Basic implementation of component of linear adjust parameters.

Definition at line 28 of file CLinearAdjustParamsComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CLinearAdjustParamsComp()

imeas::CLinearAdjustParamsComp::CLinearAdjustParamsComp ( )

Member Function Documentation

◆ GetAdjustConstraints()

const ILinearAdjustConstraints * imeas::CLinearAdjustParamsComp::GetAdjustConstraints ( ) const
overridevirtual

Get access to constraints object.

This object describes for example range of possible parameter values.

Implements imeas::ILinearAdjustParams.

◆ GetComponentValue()

double imeas::CLinearAdjustParamsComp::GetComponentValue ( ValueTypeId valueTypeId) const
overridevirtual

Get access to component value of the given type.

See also
ValueTypeId
Returns
if data vector cannot be calculated it returns empty vector.

Implements imeas::INumericValue.

◆ GetNumericConstraints()

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

Get parameter constraints describing possible parameter values.

Implements imeas::INumericValue.

◆ GetOffsetFactor()

double imeas::CLinearAdjustParamsComp::GetOffsetFactor ( ) const
overridevirtual

Get value of offset factor.

Implements imeas::ILinearAdjustParams.

◆ GetScaleFactor()

double imeas::CLinearAdjustParamsComp::GetScaleFactor ( ) const
overridevirtual

Get value of scale factor.

Implements imeas::ILinearAdjustParams.

◆ IsValueTypeSupported()

bool imeas::CLinearAdjustParamsComp::IsValueTypeSupported ( ValueTypeId valueTypeId,
bool editableOnly = false ) const
overridevirtual

Check if the given value type (or value component) is supported.

If the value component is supported you can access this via GetComponentValue method.

See also
GetComponentValue

Implements imeas::INumericValue.

◆ OnComponentCreated()

void imeas::CLinearAdjustParamsComp::OnComponentCreated ( )
overrideprotectedvirtual

Reimplemented from icomp::CComponentBase.

◆ Serialize()

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

◆ SetComponentValue()

bool imeas::CLinearAdjustParamsComp::SetComponentValue ( ValueTypeId valueTypeId,
double value )
overridevirtual

Set component value of the given type.

See also
ValueTypeId
Returns
true, if this value type is supported.

Implements imeas::INumericValue.

◆ SetOffsetFactor()

void imeas::CLinearAdjustParamsComp::SetOffsetFactor ( double offset)
overridevirtual

Set value of offset factor.

Implements imeas::ILinearAdjustParams.

◆ SetScaleFactor()

void imeas::CLinearAdjustParamsComp::SetScaleFactor ( double scale)
overridevirtual

Set value of scale factor.

Implements imeas::ILinearAdjustParams.


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

© Witold Gantzke and Kirill Lepskiy