istd::ILogger Class Reference

Common interface for classes sending some log info. More...

#include <ILogger.h>

Inheritance diagram for istd::ILogger:

Collaboration diagram for istd::ILogger:

Public Member Functions
virtual bool	IsLogConsumed (const IInformationProvider::InformationCategory *categoryPtr=nullptr, const int *flagsPtr=nullptr) const
	Check if any log message is consumed.
virtual bool	SendLogMessage (IInformationProvider::InformationCategory category, int id, const QString &message, const QString &messageSource, int flags=0) const
	Send any message to log.

Protected Member Functions
virtual void	DecorateMessage (IInformationProvider::InformationCategory category, int id, int flags, QString &message, QString &messageSource) const
	Decorate message parts before outputting.

Detailed Description

Common interface for classes sending some log info.

Default implementation is provided for convinience and it does nothing.

Definition at line 24 of file ILogger.h.

Member Function Documentation

DecorateMessage()

void istd::ILogger::DecorateMessage ( IInformationProvider::InformationCategory category, int id, int flags, QString & message, QString & messageSource ) const

inlineprotectedvirtual

Decorate message parts before outputting.

Reimplemented in ifile::CCompactXmlFileReadArchive, ifile::CCompressedXmlFileReadArchive, ifile::CFileReadArchive, ifile::CSimpleXmlFileReadArchive, ilog::CLoggerBase, ilog::TLoggerCompWrap< Base >, ilog::TLoggerCompWrap< CFileTypeInfoComp >, ilog::TLoggerCompWrap< CInstantiatorComp >, ilog::TLoggerCompWrap< ifile::CRelativeFileNameParamComp >, iser::CCompactXmlMemReadArchive, iser::CCompactXmlReadArchiveBase, and iser::CXmlStreamReadArchiveBase.

Definition at line 87 of file ILogger.h.

IsLogConsumed()

bool istd::ILogger::IsLogConsumed ( const IInformationProvider::InformationCategory * categoryPtr = nullptr, const int * flagsPtr = nullptr ) const

inlinevirtual

Check if any log message is consumed.

Default implementation retuns false.

Reimplemented in ilog::CLoggerBase.

Definition at line 66 of file ILogger.h.

Referenced by ifile::TFileSerializerComp< ReadArchive, WriteArchive >::ReadArchiveEx::IsLogConsumed(), and ifile::TFileSerializerComp< ReadArchive, WriteArchive >::WriteArchiveEx::IsLogConsumed().

SendLogMessage()

bool istd::ILogger::SendLogMessage ( IInformationProvider::InformationCategory category, int id, const QString & message, const QString & messageSource, int flags = 0 ) const

inlinevirtual

Send any message to log.

Default implementation do nothing.

Parameters

category	message category.
id	binary id identifying this message type for automatical processing.
message	message text will be send.
messageSource	source of the message.

Returns

true, if it was possible to send this message and it is 'consumed'.

Reimplemented in ilog::CLoggerBase.

Definition at line 74 of file ILogger.h.

Referenced by ifile::TFileSerializerComp< ReadArchive, WriteArchive >::ReadArchiveEx::SendLogMessage(), and ifile::TFileSerializerComp< ReadArchive, WriteArchive >::WriteArchiveEx::SendLogMessage().

---

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

• istd/ILogger.h