Component for creating single file with results of processing single input file or all files in some directory. More...

#include <CProcessingResultsReviewComp.h>

Inheritance diagram for ifileproc::CProcessingResultsReviewComp:

Collaboration diagram for ifileproc::CProcessingResultsReviewComp:

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 ifileproc::IFileConversion
enum	MessageId { MI_INPUT_PATH = 0x5cd40 , MI_OUTPUT_PATH }
	Types of messages which can be produced during execution of ConvertFiles method. More...

Public Member Functions
virtual iproc::CTaskState	ConvertFiles (const QString &inputPath, QString &outputPath, const iprm::IParamsSet paramsPtr=nullptr, iproc::IProgressManager progressManagerPtr=nullptr) const override
	Copy a file or files from `inputPath` to destination `outputPath`.

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 ifileproc::IFileConversion

Protected Member Functions
virtual bool	ProcessSingleFile (const QString &filePath, iser::IArchive &archive)
	Process single file and send the results to archive.

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

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

Detailed Description

Component for creating single file with results of processing single input file or all files in some directory.

It needs some input object storing current processed file path and supplier chain based on this path. The results will be stored in single serialization process.

Definition at line 28 of file CProcessingResultsReviewComp.h.

Member Typedef Documentation

◆ BaseClass

ilog::CLoggerComponentBase ifileproc::CProcessingResultsReviewComp::BaseClass

Definition at line 33 of file CProcessingResultsReviewComp.h.

Member Function Documentation

◆ ConvertFiles()

virtual iproc::CTaskState ifileproc::CProcessingResultsReviewComp::ConvertFiles	(	const QString &	inputPath,
		QString &	outputPath,
		const iprm::IParamsSet *	paramsPtr = nullptr,
		iproc::IProgressManager *	progressManagerPtr = nullptr ) const

overridevirtual

Copy a file or files from inputPath to destination outputPath.

Parameters

inputPath	Path to the input file or directory.
outputPath	Path to the output file or directory. Output file path can be calculated or modified inside of ConvertFiles method.
paramsPtr	File conversion parameters
progressManagerPtr	Progress manager used for getting information about file conversion progress state and canceling.

Returns: Status of conversion operation,

See also: iproc::IProcessor.

Implements ifileproc::IFileConversion.

◆ ProcessSingleFile()

virtual bool ifileproc::CProcessingResultsReviewComp::ProcessSingleFile	(	const QString &	filePath,
		iser::IArchive &	archive )

protectedvirtual

Process single file and send the results to archive.

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

ifileproc/CProcessingResultsReviewComp.h

Public Types

Public Member Functions