Bitmap loader component implementing interface icam::IBitmapAcquisition over ifile::IFilePersistence. More...

#include <CFileAcquisitionComp.h>

Inheritance diagram for icamgui::CFileAcquisitionComp:

Collaboration diagram for icamgui::CFileAcquisitionComp:

Classes
struct	ParamsInfo

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 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
	CFileAcquisitionComp ()

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.

void	InitProcessor (const iprm::IParamsSet *paramsPtr, bool doReset) override
	Init processor and give him all or part of parameters.

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.

istd::CIndex2d	GetBitmapSize (const iprm::IParamsSet *paramsPtr) const override
	Get size of acquired bitmap for specified parameters.

void	OnComponentCreated () override

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::IMessageConsumer *	GetLogPtr () 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

Protected Types
typedef QMap< QString, ParamsInfo >	DirInfos

Protected Attributes
DirInfos	m_dirInfos

quint32	m_lastIdStamp

istd::CIndex2d	m_lastImageSize

QMutex	m_lock

Protected Attributes inherited from ilog::CLoggerBase
QSet< int >	m_onceMessageIds

Additional Inherited Members
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

Detailed Description

Bitmap loader component implementing interface icam::IBitmapAcquisition over ifile::IFilePersistence.

Definition at line 31 of file CFileAcquisitionComp.h.

Member Typedef Documentation

◆ BaseClass

ilog::CLoggerComponentBase icamgui::CFileAcquisitionComp::BaseClass

Definition at line 36 of file CFileAcquisitionComp.h.

◆ DirInfos

QMap<QString, ParamsInfo> icamgui::CFileAcquisitionComp::DirInfos

protected

Definition at line 82 of file CFileAcquisitionComp.h.

Constructor & Destructor Documentation

◆ CFileAcquisitionComp()

icamgui::CFileAcquisitionComp::CFileAcquisitionComp ( )

Member Function Documentation

◆ AreParamsAccepted()

bool icamgui::CFileAcquisitionComp::AreParamsAccepted	(	const iprm::IParamsSet *	paramsPtr,
		const istd::IPolymorphic *	inputPtr,
		const istd::IChangeable *	outputPtr ) const

overridevirtual

Check if specified parameter set is accepted for this processor.

Parameters

paramsPtr	pointer to parameter object or nullptr if general state is mean.
inputPtr	optional input object typically being source object used to processing.
outputPtr	optional output object storing processing result.

Returns: true, if this parameter are accepted for processing.

Implements iproc::IProcessor.

◆ DoProcessing()

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

overridevirtual

Do synchronized processing.

Parameters

paramsPtr	pointer to parameter object. Pointed object can be used till task is finished. It can be `nullptr`.
inputPtr	optional input object typically being source object used to processing. Pointed object can be used till task is finished. It can be `nullptr`.
outputPtr	optional 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.
allowAsync	If true, than asynchronously implementation is preferred and allowed.

Returns: state of processing task

See also: TaskState.

Implements iproc::IProcessor.

◆ GetBitmapSize()

istd::CIndex2d icamgui::CFileAcquisitionComp::GetBitmapSize ( const iprm::IParamsSet * paramsPtr ) const

overridevirtual

Get size of acquired bitmap for specified parameters.

Returns: if size of bitmap is known it returns this value. Otherwise invalid size will be returned.

See also: istd::TIndex::IsValid().

Implements icam::IBitmapAcquisition.

◆ GetProcessorState()

int icamgui::CFileAcquisitionComp::GetProcessorState ( const iprm::IParamsSet * paramsPtr ) const

overridevirtual

Get state of this processor for processing of specified parameters.

Parameters

paramsPtr pointer to parameter object or nullptr if general state is mean.

Returns: state of this processor

See also: ProcessorState.

Implements iproc::IProcessor.

◆ InitProcessor()

void icamgui::CFileAcquisitionComp::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

paramsPtr	set of parameters controlling processing task. It can be `nullptr`.
doReset	true, if state of processor should be resetted before the initialization.

Implements iproc::IProcessor.

◆ OnComponentCreated()

void icamgui::CFileAcquisitionComp::OnComponentCreated ( )

override

Member Data Documentation

◆ m_dirInfos

DirInfos icamgui::CFileAcquisitionComp::m_dirInfos

protected

Definition at line 83 of file CFileAcquisitionComp.h.

◆ m_lastIdStamp

quint32 icamgui::CFileAcquisitionComp::m_lastIdStamp

protected

Definition at line 85 of file CFileAcquisitionComp.h.

◆ m_lastImageSize

istd::CIndex2d icamgui::CFileAcquisitionComp::m_lastImageSize

protected

Definition at line 87 of file CFileAcquisitionComp.h.

◆ m_lock

QMutex icamgui::CFileAcquisitionComp::m_lock

mutableprotected

Definition at line 89 of file CFileAcquisitionComp.h.

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

icamgui/CFileAcquisitionComp.h

Classes

Public Types

Public Member Functions

Protected Types

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

◆ DirInfos

Constructor & Destructor Documentation

◆ CFileAcquisitionComp()

Member Function Documentation

◆ AreParamsAccepted()

◆ DoProcessing()

◆ GetBitmapSize()

◆ GetProcessorState()

◆ InitProcessor()

◆ OnComponentCreated()

Member Data Documentation

◆ m_dirInfos

◆ m_lastIdStamp

◆ m_lastImageSize

◆ m_lock