SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND


Platform::Util
Class ILog

NonCopyableType
   |
   +-ILog

Implemented in:
Platform.Util.Log.h
Direct Known Subclasses:
FileLog

abstract class ILog:
private NonCopyableType

Provides interface for text message logging.

Inner Compounds, Typedefs, and Enumscollapse
enum Category
          Specifies logging categories.

Field Summarycollapse
UInt filter
          Category filter.

Constructor Summarycollapse
ILog()
          Constructor.
~ILog() = 0
          Destructor.

Method Summarycollapse
Void debug(const String& message) const
          Logs a debug message.
Void error(const String& message) const
          Logs an error message.
Void fatal(const String& message) const
          Logs a fatal message and immediately terminates the application.
protected String formatCategory(Category category) const
          Returns a string representation of the specified category.This method can be overridden by the implementing classes.
protected String formatTimestamp() const
          Returns a string representation of the current time.
Void info(const String& message) const
          Logs an information message.
Void trace(const String& message) const
          Logs a trace message.
Void warning(const String& message) const
          Logs a warning message.
Void write(Category category, const String& message) const
          Writes a message to the log.

 

Field Detail

filter

UInt filter

Category filter. Each logger category can be turned on and off by setting and resetting the corresponding bit of the filter member field.

 

Constructor Detail

ILog[inline]

ILog()

Constructor.


~ILog[abstract, inline]

~ILog() = 0

Destructor.

 

Method Detail

debug[inline]

Void debug(const String& message) const

Logs a debug message.

Parameters:
message - a message text

error[inline]

Void error(const String& message) const

Logs an error message.

Parameters:
message - a message text

fatal[inline]

Void fatal(const String& message) const

Logs a fatal message and immediately terminates the application.

Parameters:
message - a message text

formatCategory[virtual, inline]

protected String formatCategory(Category category) const

Returns a string representation of the specified category.This method can be overridden by the implementing classes.

Parameters:
category - a category identifier
Returns:
a string representation of the specified category

formatTimestamp[virtual, inline]

protected String formatTimestamp() const

Returns a string representation of the current time. This method can be overridden by the implementing classes.

Returns:
a string representation of the current time

info[inline]

Void info(const String& message) const

Logs an information message.

Parameters:
message - a message text

trace[inline]

Void trace(const String& message) const

Logs a trace message.

Parameters:
message - a message text

warning[inline]

Void warning(const String& message) const

Logs a warning message.

Parameters:
message - a message text

write[virtual, inline]

Void write(Category category, const String& message) const

Writes a message to the log.

Parameters:
category - a message category
message - a message text


SUMMARY:  INNER | FIELD | CONSTR | METHOD | FRIEND DETAIL:  FIELD | CONSTR | METHOD | FRIEND