Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members

ILogOutputter Class Reference

Outputter interface. More...

#include <ILogOutputter.h>

Inherits IInterface.

Inherited by CAutoStartOutputter, CBufferedLogOutputter, CConsoleLogOutputter, CFileLogOutputter, CStopLogOutputter, and CSystemLogOutputter.

Inheritance diagram for ILogOutputter:

Inheritance graph
[legend]
Collaboration diagram for ILogOutputter:

Collaboration graph
[legend]
List of all members.

Public Types

typedef CLog::ELevel ELevel

Public Member Functions

manipulators
virtual void open (const char *title)=0
 Open the outputter.
virtual void close ()=0
 Close the outputter.
virtual void show (bool showIfEmpty)=0
 Show the outputter.
virtual bool write (ELevel level, const char *message)=0
 Write a message with level.
accessors
virtual const char * getNewline () const =0
 Returns the newline sequence for the outputter.

Detailed Description

Outputter interface.

Type of outputter interface. The logger performs all output through outputters. ILogOutputter overrides must not call any log functions directly or indirectly.

Definition at line 27 of file ILogOutputter.h.


Member Function Documentation

virtual void ILogOutputter::close  )  [pure virtual]
 

Close the outputter.

Close the outputter. Calling this method on an already closed outputter must have no effect.

Implemented in CStopLogOutputter, CConsoleLogOutputter, CFileLogOutputter, CSystemLogOutputter, and CBufferedLogOutputter.

virtual const char* ILogOutputter::getNewline  )  const [pure virtual]
 

Returns the newline sequence for the outputter.

Different outputters use different character sequences for newlines. This method returns the appropriate newline sequence for this outputter.

Implemented in CStopLogOutputter, CConsoleLogOutputter, CFileLogOutputter, CSystemLogOutputter, and CBufferedLogOutputter.

Referenced by CLog::insert().

virtual void ILogOutputter::open const char *  title  )  [pure virtual]
 

Open the outputter.

Opens the outputter for writing. Calling this method on an already open outputter must have no effect.

Implemented in CStopLogOutputter, CConsoleLogOutputter, CFileLogOutputter, CSystemLogOutputter, and CBufferedLogOutputter.

Referenced by CLog::insert().

virtual void ILogOutputter::show bool  showIfEmpty  )  [pure virtual]
 

Show the outputter.

Causes the output to become visible. This generally only makes sense for a logger in a graphical user interface. Other implementations will do nothing. Iff showIfEmpty is false then the implementation may optionally only show the log if it's not empty.

Implemented in CStopLogOutputter, CConsoleLogOutputter, CFileLogOutputter, CSystemLogOutputter, and CBufferedLogOutputter.

virtual bool ILogOutputter::write ELevel  level,
const char *  message
[pure virtual]
 

Write a message with level.

Writes message, which has the given level, to a log. If this method returns true then CLog will stop passing the message to all outputters in the outputter chain, otherwise it continues. Most implementations should return true.

Implemented in CStopLogOutputter, CConsoleLogOutputter, CFileLogOutputter, CSystemLogOutputter, and CBufferedLogOutputter.


The documentation for this class was generated from the following file:
Generated on Fri Nov 6 00:21:37 2009 for synergy-plus by  doxygen 1.3.9.1