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

Interface for parameters of the blob filtering. More...

#include <IBlobFilterParams.h>

Inheritance diagram for iipr::IBlobFilterParams:
Collaboration diagram for iipr::IBlobFilterParams:

Public Types

enum  FilterOperation { FO_INCLUDE , FO_EXCLUDE }
 
enum  FilterCondition {
  FC_BETWEEN , FC_OUTSIDE , FC_LESS , FC_EQUAL ,
  FC_GREATER , FC_LESS_EQUAL , FC_GREATER_EQUAL , FC_NOT_EQUAL
}
 
- 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

 I_DECLARE_ENUM (FilterCondition, FC_BETWEEN, FC_OUTSIDE, FC_LESS, FC_EQUAL, FC_GREATER, FC_LESS_EQUAL, FC_GREATER_EQUAL, FC_NOT_EQUAL) struct Filter
 
virtual const iprm::IOptionsListGetSupportedProperties () const =0
 
virtual bool IsFiltersEnabled () const =0
 
virtual void SetFiltersEnabled (bool enabled=true)=0
 
virtual int GetFiltersCount () const =0
 
virtual Filter & GetFilterAt (int index)=0
 
virtual const Filter & GetFilterAt (int index) const =0
 
virtual void RemoveFilterAt (int index)=0
 
virtual void ResetFilters ()=0
 
virtual void AddFilter (const Filter &filterInfo)=0
 
- 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.
 
- Public Member Functions inherited from i2d::ICalibration2dProvider
virtual const ICalibration2dGetCalibration () const =0
 Get access to transformation object, which transforms a local logical coordinate system to global one.
 

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

Interface for parameters of the blob filtering.

Definition at line 27 of file IBlobFilterParams.h.

Member Enumeration Documentation

◆ FilterCondition

Enumerator
FC_BETWEEN 
FC_OUTSIDE 
FC_LESS 
FC_EQUAL 
FC_GREATER 
FC_LESS_EQUAL 
FC_GREATER_EQUAL 
FC_NOT_EQUAL 

Definition at line 45 of file IBlobFilterParams.h.

◆ FilterOperation

Enumerator
FO_INCLUDE 

If the extracted blob feature matches specified conditions, it will be passed through.

FO_EXCLUDE 

If the extracted blob feature matches specified conditions, it will be exculded from the result list.

Definition at line 30 of file IBlobFilterParams.h.

Member Function Documentation

◆ AddFilter()

virtual void iipr::IBlobFilterParams::AddFilter ( const Filter & filterInfo)
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ GetFilterAt() [1/2]

virtual const Filter & iipr::IBlobFilterParams::GetFilterAt ( int index) const
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ GetFilterAt() [2/2]

virtual Filter & iipr::IBlobFilterParams::GetFilterAt ( int index)
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ GetFiltersCount()

virtual int iipr::IBlobFilterParams::GetFiltersCount ( ) const
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ GetSupportedProperties()

virtual const iprm::IOptionsList * iipr::IBlobFilterParams::GetSupportedProperties ( ) const
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ I_DECLARE_ENUM()

iipr::IBlobFilterParams::I_DECLARE_ENUM ( FilterCondition ,
FC_BETWEEN ,
FC_OUTSIDE ,
FC_LESS ,
FC_EQUAL ,
FC_GREATER ,
FC_LESS_EQUAL ,
FC_GREATER_EQUAL ,
FC_NOT_EQUAL  )
inline

Definition at line 57 of file IBlobFilterParams.h.

◆ IsFiltersEnabled()

virtual bool iipr::IBlobFilterParams::IsFiltersEnabled ( ) const
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ RemoveFilterAt()

virtual void iipr::IBlobFilterParams::RemoveFilterAt ( int index)
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ ResetFilters()

virtual void iipr::IBlobFilterParams::ResetFilters ( )
pure virtual

Implemented in iipr::CBlobFilterParams.

◆ SetFiltersEnabled()

virtual void iipr::IBlobFilterParams::SetFiltersEnabled ( bool enabled = true)
pure virtual

Implemented in iipr::CBlobFilterParams.


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

© Witold Gantzke and Kirill Lepskiy