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

Image supplier delegating the calls to another one or accessing some bitmap object directly. More...

#include <CDelegatedBitmapSupplierComp.h>

Inheritance diagram for iipr::CDelegatedBitmapSupplierComp:
Collaboration diagram for iipr::CDelegatedBitmapSupplierComp:

Public Types

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

 CDelegatedBitmapSupplierComp ()
 
const iimg::IBitmapGetBitmap () const override
 Get access to produced bitmap object.
 
const i2d::ICalibration2dGetCalibration () const override
 Get access to transformation object, which transforms a local logical coordinate system to global one.
 
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.
 
void ClearWorkResults () override
 Remove all stored work results.
 
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 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 iimg::IBitmapProvider
- Public Member Functions inherited from i2d::ICalibration2dProvider
- Public Member Functions inherited from iinsp::ISupplier

Protected Member 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 Attributes inherited from ilog::CLoggerBase
QSet< int > m_onceMessageIds
 

Detailed Description

Image supplier delegating the calls to another one or accessing some bitmap object directly.

Definition at line 29 of file CDelegatedBitmapSupplierComp.h.

Member Typedef Documentation

◆ BaseClass

Constructor & Destructor Documentation

◆ CDelegatedBitmapSupplierComp()

iipr::CDelegatedBitmapSupplierComp::CDelegatedBitmapSupplierComp ( )

Member Function Documentation

◆ ClearWorkResults()

void iipr::CDelegatedBitmapSupplierComp::ClearWorkResults ( )
overridevirtual

Remove all stored work results.

This set also work state to WS_INIT.

Implements iinsp::ISupplier.

◆ EnsureWorkFinished()

void iipr::CDelegatedBitmapSupplierComp::EnsureWorkFinished ( )
overridevirtual

Ensure that all objects are produced.

Implements iinsp::ISupplier.

◆ EnsureWorkInitialized()

void iipr::CDelegatedBitmapSupplierComp::EnsureWorkInitialized ( )
overridevirtual

Force the supplier to initialize its work.

First if work is initialized, new calculation can be done.

Implements iinsp::ISupplier.

◆ GetBitmap()

const iimg::IBitmap * iipr::CDelegatedBitmapSupplierComp::GetBitmap ( ) const
overridevirtual

Get access to produced bitmap object.

Returns
pointer to bitmap instance if this bitmap is accessible, or nullptr.

Implements iimg::IBitmapProvider.

◆ GetCalibration()

const i2d::ICalibration2d * iipr::CDelegatedBitmapSupplierComp::GetCalibration ( ) const
overridevirtual

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

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

Implements i2d::ICalibration2dProvider.

◆ GetModelParametersSet()

iprm::IParamsSet * iipr::CDelegatedBitmapSupplierComp::GetModelParametersSet ( ) const
overridevirtual

Get parameter set using by this supplier.

The pointed object will not be relocated - no reconnect is needed if it is observed. If the supplier doesn't support parameters, it returns nullptr.

Implements iinsp::ISupplier.

◆ GetWorkMessages()

const ilog::IMessageContainer * iipr::CDelegatedBitmapSupplierComp::GetWorkMessages ( int containerType) const
overridevirtual

Get messages outputted by this work.

The pointed object will not be relocated - no reconnect is needed if it is observed. If the supplier doesn't support list of messages, it returns nullptr.

Parameters
containerTypetype of message container,
See also
MessageContainerType.

Implements iinsp::ISupplier.

◆ GetWorkStatus()

int iipr::CDelegatedBitmapSupplierComp::GetWorkStatus ( ) const
overridevirtual

Get status of last work.

Please note, that this status is not a part of supplier model and can be changed without any notification. If you want to observe the status model of the supplier, please use the GetWorkStatusModel method.

Returns
work status defined in iinsp::ISupplier::WorkStatus.
See also
GetWorkStatusModel

Implements iinsp::ISupplier.

◆ GetWorkStatusModel()

imod::IModel * iipr::CDelegatedBitmapSupplierComp::GetWorkStatusModel ( ) const
overridevirtual

Get access to the status model of the supplier.

Implements iinsp::ISupplier.

◆ InvalidateSupplier()

void iipr::CDelegatedBitmapSupplierComp::InvalidateSupplier ( )
overridevirtual

Called to signalize that this supplier is invalid.

This signal will be transfered to all supplier which are registered as output.

Returns
true, if initialization could be done.

Implements iinsp::ISupplier.

◆ OnComponentCreated()

void iipr::CDelegatedBitmapSupplierComp::OnComponentCreated ( )
overrideprotected

◆ OnComponentDestroyed()

void iipr::CDelegatedBitmapSupplierComp::OnComponentDestroyed ( )
overrideprotected

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

© Witold Gantzke and Kirill Lepskiy