Logger¶

The logger class.

Inherited by the following classes: SparkyStudios::Audio::Amplitude::ConsoleLogger, SparkyStudios::Audio::Amplitude::FileLogger, SparkyStudios::Audio::Amplitude::LogcatLogger, SparkyStudios::Audio::Amplitude::NSLogger, SparkyStudios::Audio::Amplitude::NullLogger

Detailed Description¶

Base class used to perform logging. Implementations of this class can display or store log messages wherever they are needed.

Public Functions¶

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¶

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) = 0 Logs a message with the given level.

Public Functions Documentation¶

Critical

Logs a critical message.

void Amplitude::Logger::Critical (
    const char * file,
    int line,
    const AmString & message
)

Parameters:

file The file where the message was logged.
line The line where the message was logged.
message The message to log.

Debug

Logs a debug message.

void Amplitude::Logger::Debug (
    const char * file,
    int line,
    const AmString & message
)

Parameters:

file The file where the message was logged.
line The line where the message was logged.
message The message to log.

Error

Logs an error message.

void Amplitude::Logger::Error (
    const char * file,
    int line,
    const AmString & message
)

Parameters:

file The file where the message was logged.
line The line where the message was logged.
message The message to log.

Info

Logs an informational message.

void Amplitude::Logger::Info (
    const char * file,
    int line,
    const AmString & message
)

Parameters:

file The file where the message was logged.
line The line where the message was logged.
message The message to log.

Success

Logs a success message.

void Amplitude::Logger::Success (
    const char * file,
    int line,
    const AmString & message
)

Parameters:

file The file where the message was logged.
line The line where the message was logged.
message The message to log.

Warning

Logs a warning message.

void Amplitude::Logger::Warning (
    const char * file,
    int line,
    const AmString & message
)

Parameters:

file The file where the message was logged.
line The line where the message was logged.
message The message to log.

~Logger

Default destructor.

virtual Amplitude::Logger::~Logger () = default

Public Static Functions Documentation¶

GetLogger

Gets the logger instance to use when calling amLogger .

static Logger * Amplitude::Logger::GetLogger ()

Returns:

The logger instance.

SetLogger

Sets the logger instance to use when calling amLogger .

static void Amplitude::Logger::SetLogger (
    Logger * loggerInstance
)

Parameters:

loggerInstance The logger instance.

Protected Functions Documentation¶

Log

Logs a message with the given level.

virtual void Amplitude::Logger::Log (
    eLogMessageLevel level,
    const char * file,
    int line,
    const AmString & message
) = 0

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.

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