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

#include <CSearchBasedFeaturesSupplierComp.h>

Inheritance diagram for iipr::CSearchBasedFeaturesSupplierComp:
Collaboration diagram for iipr::CSearchBasedFeaturesSupplierComp:

Public Types

typedef iinsp::TSupplierCompWrap< CFeaturesContainerBaseClass
 
- Public Types inherited from iinsp::TSupplierCompWrap< CFeaturesContainer >
typedef CSupplierCompBase BaseClass
 
typedef CFeaturesContainer ProductType
 
- Public Types inherited from iinsp::CSupplierCompBase
enum  MessageId { MI_DURATION_TIME = 0x077a1b , MI_GEOMETRICAL_RESULT , MI_SUPPLIER_RESULTS_STATUS , MI_INTERMEDIATE }
 ID of messages. More...
 
typedef ilog::CLoggerComponentBase BaseClass
 
- Public Types inherited from ilog::TLoggerCompWrap< Base >
enum  MessageId { MI_BAD_DEPENDENCY = 0x8a340 }
 
typedef Base BaseClass
 
typedef ilog::CLoggerBase BaseClass2
 
- Public Types inherited from iinsp::ISupplier
enum  WorkStatus {
  WS_INVALID , WS_INIT , WS_LOCKED , WS_OK ,
  WS_CANCELED , WS_FAILED
}
 
enum  ChangeFlags { CF_SUPPLIER_RESULTS = 0x6326415 }
 Data model change notification flags. More...
 
enum  MessageContainerType { MCT_RESULTS , MCT_TEMP , MTC_LAST = MCT_TEMP }
 
- 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 istd::IInformationProvider
enum  InformationCategory {
  IC_UNKNOWN = -1 , IC_NONE , IC_INFO , IC_WARNING ,
  IC_ERROR , IC_CRITICAL
}
 Category of information. More...
 
enum  InformationTypeFlags { ITF_DEBUG = 0x1 , ITF_SYSTEM = 0x2 , ITF_USER = 0x4 }
 Additionally information flags. More...
 

Public Member Functions

 CSearchBasedFeaturesSupplierComp ()
 
const iprm::IOptionsListGetCalibrationSelectionContraints () const override
 Get optional information about calibration objects in form of section contraints.
 
int GetCalibrationsCount () const override
 Get number of available calibrations.
 
const i2d::ICalibration2dGetCalibration (int calibrationIndex) const override
 Get access to transformation object with a given index, which transforms a local logical coordinate system to global one.
 
int GetFeaturesCount () const override
 Get number of stored features.
 
const imeas::INumericValueGetFeature (int index) const override
 Get access to single feature.
 
QDateTime GetInformationTimeStamp () const override
 Get optional time stamp of the information.
 
istd::IInformationProvider::InformationCategory GetInformationCategory () const override
 Get category of the information.
 
int GetInformationId () const override
 Get binary ID of the information using to automatical identification of this information type.
 
QString GetInformationDescription () const override
 Get the text description of the information.
 
QString GetInformationSource () const override
 Get the source of the information.
 
int GetInformationFlags () const override
 Get flags of the information.
 
- Public Member Functions inherited from iinsp::TSupplierCompWrap< CFeaturesContainer >
int ProcessWorkOutput () override
 
void ClearWorkResults () override
 Remove all stored work results.
 
- Public Member Functions inherited from iinsp::CSupplierCompBase
 CSupplierCompBase ()
 
int GetWorkStatus () const override
 Get status of last work.
 
imod::IModelGetWorkStatusModel () const override
 Get access to the status model of the supplier.
 
void InvalidateSupplier () override
 Called to signalize that this supplier is invalid.
 
void EnsureWorkInitialized () override
 Force the supplier to initialize its work.
 
void EnsureWorkFinished () override
 Ensure that all objects are produced.
 
const ilog::IMessageContainerGetWorkMessages (int containerType) const override
 Get messages outputted by this work.
 
iprm::IParamsSetGetModelParametersSet () const override
 Get parameter set using by this supplier.
 
- Public Member Functions inherited from ilog::CLoggerBase
 CLoggerBase ()
 
const QByteArray & GetVerboseSenderId () const
 Get sender ID for verbose messages.
 
void SetVerboseSenderId (const QByteArray &id)
 Set sender ID for verbose messages.
 
void SetLogPtr (ilog::IMessageConsumer *logPtr) override
 Install log.
 
ilog::IMessageConsumerGetLogPtr () const override
 Get log.
 
- Public Member Functions inherited from ilog::ILoggable
- Public Member Functions inherited from iinsp::ISupplier
- 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 iipr::IFeaturesProvider
- Public Member Functions inherited from i2d::IMultiCalibrationProvider
- Public Member Functions inherited from istd::IInformationProvider
 I_DECLARE_ENUM (InformationCategory, IC_NONE, IC_INFO, IC_WARNING, IC_ERROR, IC_CRITICAL)
 

Protected Member Functions

virtual istd::IInformationProvider::InformationCategory EvaluateResults (int featuresCount, int nominalModelsCount, QString &searchResultText) const
 
bool InitializeWork () override
 Called if the new work should be initialized.
 
int ProduceObject (CFeaturesContainer &result) const override
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from iinsp::TSupplierCompWrap< CFeaturesContainer >
const CFeaturesContainer * GetWorkProduct () const
 Get current work product, if work was done correctly.
 
virtual int ProduceObject (CFeaturesContainer &result) const=0
 Produce single object.
 
- Protected Member Functions inherited from iinsp::CSupplierCompBase
virtual void OnParametersChanged ()
 Called if the supplier parameters was changed.
 
virtual void RegisterSupplierInput (imod::IModel *modelPtr, ISupplier *supplierPtr=nullptr)
 Register supplier input.
 
virtual void UnregisterSupplierInput (imod::IModel *modelPtr)
 Unregister supplier input.
 
virtual QString GetDiagnosticName () const
 Get supplier name used for diagnostic reasons.
 
virtual bool IsMessageContainerSupported (int containerType) const
 Check if message container is supported.
 
virtual void AddMessage (const istd::IInformationProvider *messagePtr, int containerType=MCT_RESULTS) const
 Add ilog::CMessage to the internal message container (also from const functions).
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::TLoggerCompWrap< Base >
virtual void DecorateMessage (istd::IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const override
 Decorate message parts before outputting.
 
void OnComponentCreated () override
 
void OnComponentDestroyed () override
 
- Protected Member Functions inherited from ilog::CLoggerBase
bool IsVerboseEnabled () const
 Check if verbose messages are enabled.
 
bool SendVerboseMessage (const QString &message, const QString &messageSource=QString()) const
 Send verbose message.
 
bool SendInfoMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send info message to log.
 
bool SendWarningMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send warning message to log.
 
bool SendErrorMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send error message to log.
 
bool SendCriticalMessage (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send critical message to log.
 
bool SendInfoMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once info message to log.
 
bool SendWarningMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once warning message to log.
 
bool SendErrorMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once error message to log.
 
bool SendCriticalMessageOnce (int id, const QString &message, const QString &messageSource=QString(), int flags=0) const
 Send once critical message to log.
 
bool SendUserMessage (const istd::IInformationProvider *messagePtr) const
 Send message with user object.
 
bool AllowMessageOnceAgain (int id)
 Reset message lock.
 
bool IsLogConsumed (const istd::IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const override
 Check if any log message is consumed.
 
bool SendLogMessage (istd::IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const override
 Send any message to log.
 
- Protected Member Functions inherited from istd::ILogger
- 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.
 
- Protected Types inherited from iinsp::CSupplierCompBase
typedef imod::TModelWrap< StatusStatusModel
 
typedef imod::TModelWrap< ilog::CMessageContainerMessageContainer
 
- Protected Attributes inherited from iinsp::TSupplierCompWrap< CFeaturesContainer >
std::unique_ptr< CFeaturesContainer > m_productPtr
 
- Protected Attributes inherited from iinsp::CSupplierCompBase
MessageContainer m_messageContainers [MTC_LAST+1]
 
- Protected Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Definition at line 28 of file CSearchBasedFeaturesSupplierComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CSearchBasedFeaturesSupplierComp()

iipr::CSearchBasedFeaturesSupplierComp::CSearchBasedFeaturesSupplierComp ( )

Member Function Documentation

◆ EvaluateResults()

virtual istd::IInformationProvider::InformationCategory iipr::CSearchBasedFeaturesSupplierComp::EvaluateResults ( int featuresCount,
int nominalModelsCount,
QString & searchResultText ) const
protectedvirtual

◆ GetCalibration()

const i2d::ICalibration2d * iipr::CSearchBasedFeaturesSupplierComp::GetCalibration ( int calibrationIndex) const
overridevirtual

Get access to transformation object with a given index, which transforms a local logical coordinate system to global one.

Returns
Pointer to transformation if it is accessible, or nullptr.

Implements i2d::IMultiCalibrationProvider.

◆ GetCalibrationsCount()

int iipr::CSearchBasedFeaturesSupplierComp::GetCalibrationsCount ( ) const
overridevirtual

Get number of available calibrations.

Implements i2d::IMultiCalibrationProvider.

◆ GetCalibrationSelectionContraints()

const iprm::IOptionsList * iipr::CSearchBasedFeaturesSupplierComp::GetCalibrationSelectionContraints ( ) const
overridevirtual

Get optional information about calibration objects in form of section contraints.

It allows to get name and description of each calibration object.

Implements i2d::IMultiCalibrationProvider.

◆ GetFeature()

const imeas::INumericValue & iipr::CSearchBasedFeaturesSupplierComp::GetFeature ( int index) const
overridevirtual

Get access to single feature.

Implements iipr::IFeaturesProvider.

◆ GetFeaturesCount()

int iipr::CSearchBasedFeaturesSupplierComp::GetFeaturesCount ( ) const
overridevirtual

Get number of stored features.

Implements iipr::IFeaturesProvider.

◆ GetInformationCategory()

istd::IInformationProvider::InformationCategory iipr::CSearchBasedFeaturesSupplierComp::GetInformationCategory ( ) const
overridevirtual

Get category of the information.

See also
InformationCategory

Implements istd::IInformationProvider.

◆ GetInformationDescription()

QString iipr::CSearchBasedFeaturesSupplierComp::GetInformationDescription ( ) const
overridevirtual

Get the text description of the information.

If there is no description provided it contains empty string.

Implements istd::IInformationProvider.

◆ GetInformationFlags()

int iipr::CSearchBasedFeaturesSupplierComp::GetInformationFlags ( ) const
overridevirtual

Get flags of the information.

See also
InformationTypeFlags

Implements istd::IInformationProvider.

◆ GetInformationId()

int iipr::CSearchBasedFeaturesSupplierComp::GetInformationId ( ) const
overridevirtual

Get binary ID of the information using to automatical identification of this information type.

If there is no information ID it returns negative value.

Implements istd::IInformationProvider.

◆ GetInformationSource()

QString iipr::CSearchBasedFeaturesSupplierComp::GetInformationSource ( ) const
overridevirtual

Get the source of the information.

If there is no source information provided it contains empty string.

Implements istd::IInformationProvider.

◆ GetInformationTimeStamp()

QDateTime iipr::CSearchBasedFeaturesSupplierComp::GetInformationTimeStamp ( ) const
overridevirtual

Get optional time stamp of the information.

Returns
time stamp associated with this information, or null QDateTime object, if there is no associated time stamp.

Implements istd::IInformationProvider.

◆ InitializeWork()

bool iipr::CSearchBasedFeaturesSupplierComp::InitializeWork ( )
overrideprotectedvirtual

Called if the new work should be initialized.

Default implementation do nothing. It is dedicated to be overridden.

Reimplemented from iinsp::CSupplierCompBase.

◆ OnComponentCreated()

void iipr::CSearchBasedFeaturesSupplierComp::OnComponentCreated ( )
overrideprotected

◆ OnComponentDestroyed()

void iipr::CSearchBasedFeaturesSupplierComp::OnComponentDestroyed ( )
overrideprotected

◆ ProduceObject()

int iipr::CSearchBasedFeaturesSupplierComp::ProduceObject ( CFeaturesContainer & result) const
overrideprotected

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

© Witold Gantzke and Kirill Lepskiy