Public Types | Public Member Functions | Protected Member Functions | List of all members
ilog::CStreamLogCompBase Class Referenceabstract

Basic implementation for a log written to an output stream. More...

#include <CStreamLogCompBase.h>

Inheritance diagram for ilog::CStreamLogCompBase:
ilog::CLogCompBase ilog::TMessageDelegatorComp< icomp::CComponentBase > icomp::CComponentBase ilog::IMessageConsumer icomp::IComponent istd::IPolymorphic istd::IPolymorphic ifile::CTextFileLogComp ifile::CTextFileLogStreamerComp ilog::CConsoleLogComp

Public Types

typedef ilog::CLogCompBase BaseClass
 
- Public Types inherited from ilog::CLogCompBase
typedef
ilog::TMessageDelegatorComp
< icomp::CComponentBase
BaseClass
 
typedef QObject BaseClass2
 
- Public Types inherited from ilog::TMessageDelegatorComp< icomp::CComponentBase >
typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from ilog::IMessageConsumer
typedef istd::TSmartPtr< const
istd::IInformationProvider
MessagePtr
 

Public Member Functions

 CStreamLogCompBase ()
 
istd::IInformationProvider::InformationCategory GetWorseCategory () const
 Get worse category (highest code) of all outputed messages. More...
 
virtual bool IsMessageSupported (int messageCategory=-1, int messageId=-1, const istd::IInformationProvider *messagePtr=NULL) const
 Check if some messge is supported. More...
 
- Public Member Functions inherited from ilog::CLogCompBase
 CLogCompBase ()
 
virtual void AddMessage (const MessagePtr &messagePtr)
 Adds a message item to the container. More...
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context. More...
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component. More...
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface. More...
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry. More...
 
virtual void SetComponentContext (const icomp::IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Protected Member Functions

virtual void WriteMessageToStream (const istd::IInformationProvider &message)
 Write formatted message to the output stream. More...
 
virtual QString GenerateMessageText (const istd::IInformationProvider &message) const
 Generate formatted message text for the output. More...
 
virtual void WriteText (const QString &text, istd::IInformationProvider::InformationCategory category)=0
 Write a text line to the output stream. More...
 
virtual void WriteMessageToLog (const MessagePtr &messagePtr)
 
virtual void OnComponentDestroyed ()
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active. More...
 
virtual void OnComponentCreated ()
 
virtual const
icomp::IRealComponentStaticInfo
GetComponentStaticInfo () const =0
 Get access to static info of this component. More...
 

Additional Inherited Members

- Signals inherited from ilog::CLogCompBase
void EmitAddMessage (const MessagePtr &messagePtr)
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const
icomp::IRealComponentStaticInfo
InitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Basic implementation for a log written to an output stream.

Definition at line 18 of file CStreamLogCompBase.h.

Member Typedef Documentation

Definition at line 21 of file CStreamLogCompBase.h.

Constructor & Destructor Documentation

ilog::CStreamLogCompBase::CStreamLogCompBase ( )

Member Function Documentation

virtual QString ilog::CStreamLogCompBase::GenerateMessageText ( const istd::IInformationProvider message) const
protectedvirtual

Generate formatted message text for the output.

istd::IInformationProvider::InformationCategory ilog::CStreamLogCompBase::GetWorseCategory ( ) const

Get worse category (highest code) of all outputed messages.

virtual bool ilog::CStreamLogCompBase::IsMessageSupported ( int  messageCategory = -1,
int  messageId = -1,
const istd::IInformationProvider messagePtr = NULL 
) const
virtual

Check if some messge is supported.

Parameters
messageCategorycategory of message or -1 if undefined,
See Also
istd::IInformationProvider::InformationCategory.
Parameters
messageIdID of message as defined in istd::IInformationProvider or -1 if undefined.
messagePtroptional message object, or NULL if undefined. Please note, this object will not be stored by receiver.

Reimplemented from ilog::TMessageDelegatorComp< icomp::CComponentBase >.

virtual void ilog::CStreamLogCompBase::OnComponentDestroyed ( )
protectedvirtual
virtual void ilog::CStreamLogCompBase::WriteMessageToLog ( const MessagePtr messagePtr)
protectedvirtual

Implements ilog::CLogCompBase.

virtual void ilog::CStreamLogCompBase::WriteMessageToStream ( const istd::IInformationProvider message)
protectedvirtual

Write formatted message to the output stream.

virtual void ilog::CStreamLogCompBase::WriteText ( const QString &  text,
istd::IInformationProvider::InformationCategory  category 
)
protectedpure virtual

Write a text line to the output stream.

Implemented in ifile::CTextFileLogStreamerComp, ifile::CTextFileLogComp, and ilog::CConsoleLogComp.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy