ICF 3.0.5.47
Technical documentation of ICF Libraries
iipr::CSearchParams Class Reference

Definition of standard search parameters. More...

#include <CSearchParams.h>

Inheritance diagram for iipr::CSearchParams:
Collaboration diagram for iipr::CSearchParams:

Public Member Functions

 CSearchParams ()
 
virtual const ISearchConstraintsGetSearchConstraints () const
 Get constraints for the search parameters.
 
virtual double GetMinScore () const
 Get minimum score for a succefull search.
 
virtual void SetMinScore (double minScore)
 Set minimum score for a succefull search.
 
virtual const istd::CRangeGetRotationRange () const
 Get rotation range for the model search.
 
virtual void SetRotationRange (const istd::CRange &angleRange)
 Set rotation range for the model search.
 
virtual const istd::CRangeGetScaleRange () const
 Get scale range for the model search.
 
virtual void SetScaleRange (const istd::CRange &scaleRange)
 Set scale range for the model search.
 
virtual int GetNominalModelsCount () const
 Get the number of models that should be found for a successfull search result.
 
virtual void SetNominalModelsCount (int nominalModelsCount)
 Set the number of models that should be found for a successfull search result.
 
virtual bool IsRotationEnabled () const
 
virtual void SetRotationEnabled (bool isRotationEnabled)
 
virtual bool IsScaleEnabled () const
 
virtual void SetScaleEnabled (bool isScaleEnabled)
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream.
 
- Public Member Functions inherited from iipr::ISearchParams
- 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.
 

Protected Attributes

istd::CRange m_angleRange
 
istd::CRange m_scaleRange
 
int m_nominalModelsCount
 
double m_minScore
 
bool m_isRotationEnabled
 
bool m_isScaleEnabled
 

Additional Inherited Members

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

Definition of standard search parameters.

Definition at line 22 of file CSearchParams.h.

Constructor & Destructor Documentation

◆ CSearchParams()

iipr::CSearchParams::CSearchParams ( )

Member Function Documentation

◆ GetMinScore()

virtual double iipr::CSearchParams::GetMinScore ( ) const
virtual

Get minimum score for a succefull search.

Implements iipr::ISearchParams.

◆ GetNominalModelsCount()

virtual int iipr::CSearchParams::GetNominalModelsCount ( ) const
virtual

Get the number of models that should be found for a successfull search result.

Implements iipr::ISearchParams.

◆ GetRotationRange()

virtual const istd::CRange & iipr::CSearchParams::GetRotationRange ( ) const
virtual

Get rotation range for the model search.

Implements iipr::ISearchParams.

◆ GetScaleRange()

virtual const istd::CRange & iipr::CSearchParams::GetScaleRange ( ) const
virtual

Get scale range for the model search.

See also
SetScaleRange()

Implements iipr::ISearchParams.

◆ GetSearchConstraints()

virtual const ISearchConstraints * iipr::CSearchParams::GetSearchConstraints ( ) const
virtual

Get constraints for the search parameters.

Implements iipr::ISearchParams.

Reimplemented in iipr::CSearchParamsComp.

◆ IsRotationEnabled()

virtual bool iipr::CSearchParams::IsRotationEnabled ( ) const
virtual

◆ IsScaleEnabled()

virtual bool iipr::CSearchParams::IsScaleEnabled ( ) const
virtual

◆ Serialize()

virtual bool iipr::CSearchParams::Serialize ( iser::IArchive & archive)
virtual

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.

◆ SetMinScore()

virtual void iipr::CSearchParams::SetMinScore ( double minScore)
virtual

Set minimum score for a succefull search.

Implements iipr::ISearchParams.

◆ SetNominalModelsCount()

virtual void iipr::CSearchParams::SetNominalModelsCount ( int nominalModelsCount)
virtual

Set the number of models that should be found for a successfull search result.

Parameters
nominalModelsCountnumber of models. The negative value means any number of models can be found.

Implements iipr::ISearchParams.

◆ SetRotationEnabled()

virtual void iipr::CSearchParams::SetRotationEnabled ( bool isRotationEnabled)
virtual

◆ SetRotationRange()

virtual void iipr::CSearchParams::SetRotationRange ( const istd::CRange & angleRange)
virtual

Set rotation range for the model search.

Range [0, 0] means the rotation invariance is off.

Implements iipr::ISearchParams.

◆ SetScaleEnabled()

virtual void iipr::CSearchParams::SetScaleEnabled ( bool isScaleEnabled)
virtual

◆ SetScaleRange()

virtual void iipr::CSearchParams::SetScaleRange ( const istd::CRange & scaleRange)
virtual

Set scale range for the model search.

Range [0, 0] means the scaling invariance is off.

Implements iipr::ISearchParams.

Member Data Documentation

◆ m_angleRange

istd::CRange iipr::CSearchParams::m_angleRange
protected

Definition at line 46 of file CSearchParams.h.

◆ m_isRotationEnabled

bool iipr::CSearchParams::m_isRotationEnabled
protected

Definition at line 50 of file CSearchParams.h.

◆ m_isScaleEnabled

bool iipr::CSearchParams::m_isScaleEnabled
protected

Definition at line 51 of file CSearchParams.h.

◆ m_minScore

double iipr::CSearchParams::m_minScore
protected

Definition at line 49 of file CSearchParams.h.

◆ m_nominalModelsCount

int iipr::CSearchParams::m_nominalModelsCount
protected

Definition at line 48 of file CSearchParams.h.

◆ m_scaleRange

istd::CRange iipr::CSearchParams::m_scaleRange
protected

Definition at line 47 of file CSearchParams.h.


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

© Witold Gantzke and Kirill Lepskiy