zeus::ILogger Class Reference

#include <ILogger.hpp>

Inheritance diagram for zeus::ILogger:

List of all members.

Public Member Functions
virtual Retval MQUALIFIER	getLogger (const IString &rName, ILogger *&rpLogger)=0
virtual void MQUALIFIER	printDebug (const IString &rMessage)=0
virtual void MQUALIFIER	printError (const IString &rMessage)=0
virtual void MQUALIFIER	printFatal (const IString &rMessage)=0
virtual void MQUALIFIER	printInfo (const IString &rMessage)=0
virtual void MQUALIFIER	printWarn (const IString &rMessage)=0
virtual bool MQUALIFIER	isDebugEnabled ()=0
virtual bool MQUALIFIER	isErrorEnabled ()=0
virtual bool MQUALIFIER	isFatalEnabled ()=0
virtual bool MQUALIFIER	isInfoEnabled ()=0
virtual bool MQUALIFIER	isWarnEnabled ()=0
virtual Retval MQUALIFIER	loadConfiguration (const IString &rFileName)=0
virtual Retval MQUALIFIER	loadProperties (IPropertyAccess &rProp)=0

---

Detailed Description

This interface defines the logging mechanisme.

---

Member Function Documentation

virtual Retval MQUALIFIER zeus::ILogger::getLogger	(	const IString &	rName,
		ILogger *&	rpLogger
	)		[pure virtual]

Returns a new logger interface. If the name is NULL or empty, the root logger will be returned.

Parameters:

rName	: Name of the logger
rpLogger	: Return parameter of the logger

Return values:

RET_NOERROR	: Logger returned
RET_ERR_REQUEST_FAILED	: Could not return the logger

Implemented in zeus::TStdLogger.

virtual bool MQUALIFIER zeus::ILogger::isDebugEnabled

(

)

[pure virtual]

Checks if the debug output is enabled

Return values:

true	: enabled
false,:	disabled

Implemented in zeus::TStdLogger.

virtual bool MQUALIFIER zeus::ILogger::isErrorEnabled

(

)

[pure virtual]

Checks if the error output is enabled

Return values:

true	: enabled
false,:	disabled

Implemented in zeus::TStdLogger.

virtual bool MQUALIFIER zeus::ILogger::isFatalEnabled

(

)

[pure virtual]

Checks if the fatal error output is enabled

Return values:

true	: enabled
false,:	disabled

Implemented in zeus::TStdLogger.

virtual bool MQUALIFIER zeus::ILogger::isInfoEnabled

(

)

[pure virtual]

Checks if the info output is enabled

Return values:

true	: enabled
false,:	disabled

Implemented in zeus::TStdLogger.

virtual bool MQUALIFIER zeus::ILogger::isWarnEnabled

(

)

[pure virtual]

Checks if the warning output is enabled

Return values:

true	: enabled
false,:	disabled

Implemented in zeus::TStdLogger.

virtual Retval MQUALIFIER zeus::ILogger::loadConfiguration

(

const IString &

rFileName )

[pure virtual]

Loads the settings from a file

Parameters:

rFileName

: Name and path of file to load

Return values:

RET_NOERROR	: File found and settings loaded
RET_REQUEST_FAILED	: Could not load settings

Implemented in zeus::TStdLogger.

virtual Retval MQUALIFIER zeus::ILogger::loadProperties

(

IPropertyAccess &

rProp )

[pure virtual]

Loads the settings directly from the properties

Parameters:

rProp

: Properties instance

Return values:

RET_NOERROR	: Settings loaded
RET_REQUEST_FAILED	: Could not load settings

Implemented in zeus::TStdLogger.

virtual void MQUALIFIER zeus::ILogger::printDebug

(

const IString &

rMessage )

[pure virtual]

prints a debug message to the logger

Parameters:

rMessage

: Message to print

Implemented in zeus::TStdLogger.

virtual void MQUALIFIER zeus::ILogger::printError

(

const IString &

rMessage )

[pure virtual]

prints a error message to the logger

Parameters:

rMessage

: Message to print

Implemented in zeus::TStdLogger.

virtual void MQUALIFIER zeus::ILogger::printFatal

(

const IString &

rMessage )

[pure virtual]

prints a fatal error message to the logger

Parameters:

rMessage

: Message to print

Implemented in zeus::TStdLogger.

virtual void MQUALIFIER zeus::ILogger::printInfo

(

const IString &

rMessage )

[pure virtual]

prints a info message to the logger

Parameters:

rMessage

: Message to print

Implemented in zeus::TStdLogger.

virtual void MQUALIFIER zeus::ILogger::printWarn

(

const IString &

rMessage )

[pure virtual]

prints a warning to the logger

Parameters:

rMessage

: Message to print

Implemented in zeus::TStdLogger.

---

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

• ILogger.hpp