ICF 3.0.5.47
Technical documentation of ICF Libraries
iipr::TWeightedFeatureWrap< BaseObject > Class Template Reference

Wrapper allowing to create feature object from some another serializable one. More...

#include <TWeightedFeatureWrap.h>

Inheritance diagram for iipr::TWeightedFeatureWrap< BaseObject >:
Collaboration diagram for iipr::TWeightedFeatureWrap< BaseObject >:

Public Types

typedef imeas::CGeneralNumericValue BaseClass
 
typedef BaseObject 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

 TWeightedFeatureWrap (double weight=1.0)
 
double GetWeight () const
 
void SetWeight (double weight)
 
bool IsValueTypeSupported (ValueTypeId valueTypeId, bool editableOnly=false) const override
 
double GetComponentValue (ValueTypeId valueTypeId) const override
 
bool SetComponentValue (ValueTypeId valueTypeId, double value) override
 
bool Serialize (iser::IArchive &archive) override
 Load or store state of this object as a archive stream.
 
bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 
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::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.
 
const imeas::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 CopyFrom (const istd::IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS) override
 Copy this object from another one.
 
- 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 Attributes

double m_weight
 
- Protected Attributes inherited from imeas::CGeneralNumericValue
ComponentsMap m_componentsMap
 

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

template<class BaseObject>
class iipr::TWeightedFeatureWrap< BaseObject >

Wrapper allowing to create feature object from some another serializable one.

Definition at line 23 of file TWeightedFeatureWrap.h.

Member Typedef Documentation

◆ BaseClass

template<class BaseObject >
imeas::CGeneralNumericValue iipr::TWeightedFeatureWrap< BaseObject >::BaseClass

Definition at line 28 of file TWeightedFeatureWrap.h.

◆ BaseClass2

template<class BaseObject >
BaseObject iipr::TWeightedFeatureWrap< BaseObject >::BaseClass2

Definition at line 29 of file TWeightedFeatureWrap.h.

Constructor & Destructor Documentation

◆ TWeightedFeatureWrap()

template<class BaseObject >
iipr::TWeightedFeatureWrap< BaseObject >::TWeightedFeatureWrap ( double weight = 1.0)

Definition at line 57 of file TWeightedFeatureWrap.h.

Member Function Documentation

◆ CloneMe()

template<class BaseObject >
std::unique_ptr< istd::IChangeable > iipr::TWeightedFeatureWrap< BaseObject >::CloneMe ( CompatibilityMode mode = CM_WITHOUT_REFS) const
overridevirtual

Make a copy of this object.

You may check, if this functionality is supported over GetSupportedOperations().

Returns
new instance or nullptr, if this operation is not supported.

Reimplemented from imeas::CGeneralNumericValue.

Definition at line 146 of file TWeightedFeatureWrap.h.

◆ CopyFrom()

template<class BaseObject >
bool iipr::TWeightedFeatureWrap< BaseObject >::CopyFrom ( const IChangeable & object,
CompatibilityMode mode = CM_WITHOUT_REFS )
override

◆ GetComponentValue()

template<class BaseObject >
double iipr::TWeightedFeatureWrap< BaseObject >::GetComponentValue ( ValueTypeId valueTypeId) const
override

Definition at line 87 of file TWeightedFeatureWrap.h.

◆ GetWeight()

template<class BaseObject >
double iipr::TWeightedFeatureWrap< BaseObject >::GetWeight ( ) const

◆ IsValueTypeSupported()

template<class BaseObject >
bool iipr::TWeightedFeatureWrap< BaseObject >::IsValueTypeSupported ( ValueTypeId valueTypeId,
bool editableOnly = false ) const
override

Definition at line 80 of file TWeightedFeatureWrap.h.

◆ ResetData()

template<class BaseObject >
bool iipr::TWeightedFeatureWrap< BaseObject >::ResetData ( CompatibilityMode mode = CM_WITHOUT_REFS)
overridevirtual

Reset data to its default state.

Default implementation in istd::IChangeable does nothing. You may check, if this functionality is supported over GetSupportedOperations().

Returns
true if the operation was successful, and false otherwise.

Reimplemented from imeas::CGeneralNumericValue.

Definition at line 159 of file TWeightedFeatureWrap.h.

◆ Serialize()

template<class BaseObject >
bool iipr::TWeightedFeatureWrap< BaseObject >::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

Reimplemented from imeas::CGeneralNumericValue.

Definition at line 112 of file TWeightedFeatureWrap.h.

References iser::IArchive::BeginTag(), iser::IArchive::EndTag(), iser::IArchive::IsChanging(), iser::IArchive::Process(), and iser::CArchiveTag::TT_LEAF.

◆ SetComponentValue()

template<class BaseObject >
bool iipr::TWeightedFeatureWrap< BaseObject >::SetComponentValue ( ValueTypeId valueTypeId,
double value )
override

Definition at line 98 of file TWeightedFeatureWrap.h.

◆ SetWeight()

template<class BaseObject >
void iipr::TWeightedFeatureWrap< BaseObject >::SetWeight ( double weight)

Definition at line 71 of file TWeightedFeatureWrap.h.

Member Data Documentation

◆ m_weight

template<class BaseObject >
double iipr::TWeightedFeatureWrap< BaseObject >::m_weight
protected

Definition at line 50 of file TWeightedFeatureWrap.h.


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

© Witold Gantzke and Kirill Lepskiy