OpenAssetIO
An abstract API for generalising interactions between a host application and an asset management system
|
A logger that sends messages to the console (stderr). More...
#include <ConsoleLogger.hpp>
Public Types | |
using | Ptr = ConsoleLoggerPtr |
using | ConstPtr = ConsoleLoggerConstPtr |
![]() | |
using | Ptr = LoggerInterfacePtr |
using | ConstPtr = LoggerInterfaceConstPtr |
enum | Severity { kDebugApi, kDebug, kInfo, kProgress, kWarning, kError, kCritical } |
Public Member Functions | |
void | log (Severity severity, const Str &message) override |
Logs a message to the user. More... | |
![]() | |
virtual | ~LoggerInterface () |
Defaulted polymorphic destructor. More... | |
virtual bool | isSeverityLogged (Severity severity) const |
Check if a given severity level should/will be filtered out. More... | |
void | debugApi (const Str &message) |
void | debug (const Str &message) |
void | info (const Str &message) |
void | progress (const Str &message) |
void | warning (const Str &message) |
void | error (const Str &message) |
void | critical (const Str &message) |
Static Public Member Functions | |
static ConsoleLoggerPtr | make (bool shouldColorOutput=true) |
Creates a new instance of the ConsoleLogger. More... | |
Additional Inherited Members | |
![]() | |
static constexpr std::array | kSeverityNames |
A logger that sends messages to the console (stderr).
using ConstPtr = ConsoleLoggerConstPtr |
using Ptr = ConsoleLoggerPtr |
Logs a message to the user.
This method must be implemented to present the supplied message to the user in an appropriate fashion.
severity | One of the severity constants defined in Severity. |
message | The message string to be logged. |
Implements LoggerInterface.
|
static |
Creates a new instance of the ConsoleLogger.
shouldColorOutput | When true, messages will be colored based on their severity. |
Copyright 2013-2023 The Foundry Visionmongers Ltd. OpenAssetIO is released under the Apache 2.0 License