ILogger Class Reference

Define the interface of the logging facility. More...

Inherited by DSILog, DSILogger, and ETWLogger.

List of all members.

Public Member Functions

virtual const simba_stringGetLocale () const =0
 Gets the locale for this logger.
virtual Simba::Support::LogLevel GetLogLevel () const =0
 Gets the current LogLevel.
virtual void LogDebug (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const simba_char *const in_messageFormat,...)=0
 If the log level is greater than or equal to DEBUG, log the message.
virtual void LogError (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const simba_char *const in_messageFormat,...)=0
 If the log level is greater than or equal to ERROR, log the message.
virtual void LogError (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const ErrorException &in_exception)=0
 If the log level is greater than or equal to ERROR, log the message.
virtual void LogFatal (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const simba_char *const in_messageFormat,...)=0
 If the log level is greater than or equal to FATAL, log the message.
virtual void LogFunctionEntrance (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName)=0
 If the log level is greater than or equal to DEBUG, log the message.
virtual void LogInfo (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const simba_char *const in_messageFormat,...)=0
 If the log level is greater than or equal to INFO, log the message.
virtual void LogTrace (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const simba_char *const in_messageFormat,...)=0
 If the log level is greater than or equal to TRACE, log the message, then log a stack trace.
virtual void LogWarning (const simba_char *const in_namespace, const simba_char *const in_className, const simba_char *const in_functionName, const simba_char *const in_messageFormat,...)=0
 If the log level is greater than or equal to WARNING, log the message.
virtual void SetLocale (const simba_string &in_locale)=0
 Sets the Locale for this logger.
virtual void SetLogLevel (LogLevel in_logLevel)=0
 Sets a new LogLevel for this logger.
virtual ~ILogger ()
 Destructor.

Protected Member Functions

 ILogger ()
 Constructor.

Detailed Description

Define the interface of the logging facility.


Constructor & Destructor Documentation

virtual ~ILogger (  )  [inline, virtual]

Destructor.

ILogger (  )  [inline, protected]

Constructor.


Member Function Documentation

virtual const simba_string& GetLocale (  )  const [pure virtual]

Gets the locale for this logger.

Returns:
The locale for this logger.

Implemented in DSILog, DSILogger, and ETWLogger.

virtual Simba::Support::LogLevel GetLogLevel (  )  const [pure virtual]

Gets the current LogLevel.

Returns:
The current LogLevel.

Implemented in DSILog, DSILogger, and ETWLogger.

virtual void LogDebug ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const simba_char *const   in_messageFormat,
  ... 
) [pure virtual]

If the log level is greater than or equal to DEBUG, log the message.

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_messageFormat The message to log. May contain printf style conversion chars. (NOT OWN)
... Variable arguments list for printf style conversions.
virtual void LogError ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const simba_char *const   in_messageFormat,
  ... 
) [pure virtual]

If the log level is greater than or equal to ERROR, log the message.

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_messageFormat The message to log. May contain printf style conversion chars. (NOT OWN)
... Variable arguments list for printf style conversions.
virtual void LogError ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const ErrorException in_exception 
) [pure virtual]

If the log level is greater than or equal to ERROR, log the message.

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_exception The exception to log.
virtual void LogFatal ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const simba_char *const   in_messageFormat,
  ... 
) [pure virtual]

If the log level is greater than or equal to FATAL, log the message.

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_messageFormat The message to log. May contain printf style conversion chars. (NOT OWN)
... Variable arguments list for printf style conversions.
virtual void LogFunctionEntrance ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName 
) [pure virtual]

If the log level is greater than or equal to DEBUG, log the message.

The message will be something similar to: <fileName><functionName> +++++ enter +++++

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
virtual void LogInfo ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const simba_char *const   in_messageFormat,
  ... 
) [pure virtual]

If the log level is greater than or equal to INFO, log the message.

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_messageFormat The message to log. May contain printf style conversion chars. (NOT OWN)
... Variable arguments list for printf style conversions.
virtual void LogTrace ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const simba_char *const   in_messageFormat,
  ... 
) [pure virtual]

If the log level is greater than or equal to TRACE, log the message, then log a stack trace.

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_messageFormat The message to log. May contain printf style conversion chars. (NOT OWN)
... Variable arguments list for printf style conversions.
virtual void LogWarning ( const simba_char *const   in_namespace,
const simba_char *const   in_className,
const simba_char *const   in_functionName,
const simba_char *const   in_messageFormat,
  ... 
) [pure virtual]

If the log level is greater than or equal to WARNING, log the message.

Initializes logger, if it hasn't already.

Parameters:
in_namespace The namespace of the function attempting to log. (NOT OWN)
in_className The name of the class to log. (NOT OWN)
in_functionName The name of the function to log. (NOT OWN)
in_messageFormat The message to log. May contain printf style conversion chars. (NOT OWN)
... Variable arguments list for printf style conversions.
virtual void SetLocale ( const simba_string in_locale  )  [pure virtual]

Sets the Locale for this logger.

Parameters:
in_locale The new locale.
virtual void SetLogLevel ( LogLevel  in_logLevel  )  [pure virtual]

Sets a new LogLevel for this logger.

Parameters:
in_logLevel The new LogLevel.

Implemented in DSILog, DSILogger, and ETWLogger.


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

Generated on Wed May 17 14:21:19 2017 for SimbaEngine 10.1.3.1011 by simba