ICF 3.0.5.47
Technical documentation of ICF Libraries
iipr::ISearchParams Class Referenceabstract

Common interface for a set of parameters for a model search. More...

#include <ISearchParams.h>

Inheritance diagram for iipr::ISearchParams:
Collaboration diagram for iipr::ISearchParams:

Public Member Functions

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

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

Common interface for a set of parameters for a model search.

Definition at line 26 of file ISearchParams.h.

Member Function Documentation

◆ GetMinScore()

virtual double iipr::ISearchParams::GetMinScore ( ) const
pure virtual

Get minimum score for a succefull search.

Implemented in iipr::CSearchParams.

◆ GetNominalModelsCount()

virtual int iipr::ISearchParams::GetNominalModelsCount ( ) const
pure virtual

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

Implemented in iipr::CSearchParams.

◆ GetRotationRange()

virtual const istd::CRange & iipr::ISearchParams::GetRotationRange ( ) const
pure virtual

Get rotation range for the model search.

Implemented in iipr::CSearchParams.

◆ GetScaleRange()

virtual const istd::CRange & iipr::ISearchParams::GetScaleRange ( ) const
pure virtual

Get scale range for the model search.

See also
SetScaleRange()

Implemented in iipr::CSearchParams.

◆ GetSearchConstraints()

virtual const ISearchConstraints * iipr::ISearchParams::GetSearchConstraints ( ) const
pure virtual

Get constraints for the search parameters.

Implemented in iipr::CSearchParams, and iipr::CSearchParamsComp.

◆ SetMinScore()

virtual void iipr::ISearchParams::SetMinScore ( double minScore)
pure virtual

Set minimum score for a succefull search.

Implemented in iipr::CSearchParams.

◆ SetNominalModelsCount()

virtual void iipr::ISearchParams::SetNominalModelsCount ( int nominalModelsCount)
pure 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.

Implemented in iipr::CSearchParams.

◆ SetRotationRange()

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

Set rotation range for the model search.

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

Implemented in iipr::CSearchParams.

◆ SetScaleRange()

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

Set scale range for the model search.

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

Implemented in iipr::CSearchParams.


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

© Witold Gantzke and Kirill Lepskiy