ICF 3.0.5.47
Technical documentation of ICF Libraries
icam::CProcessedCameraComp Class Reference

Camera delegator with integrated pre- and post-processing. More...

#include <CProcessedCameraComp.h>

Inheritance diagram for icam::CProcessedCameraComp:
Collaboration diagram for icam::CProcessedCameraComp:

Public Types

typedef icam::CCameraDelegatorComp BaseClass
 
- Public Types inherited from icam::CCameraDelegatorComp
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 iproc::IProcessor
enum  MessageId { MI_BAD_PARAMS = 0x16372620 , MI_PROCESSING_ERROR }
 
enum  ProcessorState { PS_UNKNOWN , PS_INITIALIZATION , PS_READY , PS_INVALID }
 State of processing. More...
 

Public Member Functions

void InitProcessor (const iprm::IParamsSet *paramsPtr, bool doReset) override
 Init processor and give him all or part of parameters.
 
virtual iproc::CTaskState DoProcessing (const iprm::IParamsSet *paramsPtr, const istd::IPolymorphic *inputPtr, istd::IChangeable *outputPtr, bool allowAsync=false, iproc::IProgressManager *progressManagerPtr=nullptr) override
 Do synchronized processing.
 
- Public Member Functions inherited from icam::CCameraDelegatorComp
istd::CIndex2d GetBitmapSize (const iprm::IParamsSet *paramsPtr) const override
 Get size of acquired bitmap for specified parameters.
 
int GetProcessorState (const iprm::IParamsSet *paramsPtr) const override
 Get state of this processor for processing of specified parameters.
 
bool AreParamsAccepted (const iprm::IParamsSet *paramsPtr, const istd::IPolymorphic *inputPtr, const istd::IChangeable *outputPtr) const override
 Check if specified parameter set is accepted for this processor.
 
- 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 icam::IBitmapAcquisition
- Public Member Functions inherited from iproc::IProcessor

Additional Inherited Members

- Protected 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...
 
- Protected Member Functions inherited from icam::CCameraDelegatorComp
virtual const iprm::IParamsSetGetWorkingParamsSet (const iprm::IParamsSet *inputParamsPtr) const
 
void OnComponentCreated () 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.
 
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.
 
- Static Protected 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

Camera delegator with integrated pre- and post-processing.

Definition at line 21 of file CProcessedCameraComp.h.

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ DoProcessing()

virtual iproc::CTaskState icam::CProcessedCameraComp::DoProcessing ( const iprm::IParamsSet * paramsPtr,
const istd::IPolymorphic * inputPtr,
istd::IChangeable * outputPtr,
bool allowAsync = false,
iproc::IProgressManager * progressManagerPtr = nullptr )
overridevirtual

Do synchronized processing.

Parameters
paramsPtrpointer to parameter object. Pointed object can be used till task is finished. It can be nullptr.
inputPtroptional input object typically being source object used to processing. Pointed object can be used till task is finished. It can be nullptr.
outputPtroptional output object storing processing result. Pointed object can be used till task is finished. It can be nullptr, but typically it means that there is nothing to do.
allowAsyncIf true, than asynchronously implementation is preferred and allowed.
Returns
state of processing task
See also
TaskState.

Reimplemented from icam::CCameraDelegatorComp.

◆ InitProcessor()

void icam::CProcessedCameraComp::InitProcessor ( const iprm::IParamsSet * paramsPtr,
bool doReset )
overridevirtual

Init processor and give him all or part of parameters.

Please note, that initalizing will be also done automatically in method DoProcessing but it is recommended to use this method to avoid unpredictable waiting time during time critical processing.

Parameters
paramsPtrset of parameters controlling processing task. It can be nullptr.
doResettrue, if state of processor should be resetted before the initialization.

Reimplemented from icam::CCameraDelegatorComp.


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

© Witold Gantzke and Kirill Lepskiy