Skip to content

ConsoleLogger

A Logger implementation that outputs messages to the console.

Inherits the following classes: SparkyStudios::Audio::Amplitude::Logger

Public Functions

Type Name
ConsoleLogger (bool displayFileAndLine=true)
Constructs a new console logger.
~ConsoleLogger () override
Default destructor.

Public Functions inherited from SparkyStudios::Audio::Amplitude::Logger

See SparkyStudios::Audio::Amplitude::Logger

Type Name
void Critical (const char * file, int line, const AmString & message)
Logs a critical message.
void Debug (const char * file, int line, const AmString & message)
Logs a debug message.
void Error (const char * file, int line, const AmString & message)
Logs an error message.
void Info (const char * file, int line, const AmString & message)
Logs an informational message.
void Success (const char * file, int line, const AmString & message)
Logs a success message.
void Warning (const char * file, int line, const AmString & message)
Logs a warning message.
virtual ~Logger () = default
Default destructor.

Public Static Functions inherited from SparkyStudios::Audio::Amplitude::Logger

See SparkyStudios::Audio::Amplitude::Logger

Type Name
Logger * GetLogger ()
Gets the logger instance to use when calling amLogger .
void SetLogger (Logger * loggerInstance)
Sets the logger instance to use when calling amLogger .

Protected Functions

Type Name
virtual void Log (eLogMessageLevel level, const char * file, int line, const AmString & message) override
Logs a message with the given level.

Protected Functions inherited from SparkyStudios::Audio::Amplitude::Logger

See SparkyStudios::Audio::Amplitude::Logger

Type Name
virtual void Log (eLogMessageLevel level, const char * file, int line, const AmString & message) = 0
Logs a message with the given level.

Public Functions Documentation

ConsoleLogger

Constructs a new console logger. 

explicit Amplitude::ConsoleLogger::ConsoleLogger (
    bool displayFileAndLine=true
)

Parameters:

  • displayFileAndLine Whether to display the file and line number in the log messages.
~ConsoleLogger

Default destructor. 

Amplitude::ConsoleLogger::~ConsoleLogger () override

Protected Functions Documentation

Log

Logs a message with the given level. 

virtual void Amplitude::ConsoleLogger::Log (
    eLogMessageLevel level,
    const char * file,
    int line,
    const AmString & message
) override

Parameters:

  • level The level of the log message.
  • file The file where the message was logged.
  • line The line where the message was logged.
  • message The message to log.

Implements SparkyStudios::Audio::Amplitude::Logger::Log

The documentation for this class was generated from the following file: include/SparkyStudios/Audio/Amplitude/IO/ConsoleLogger.h