ALib C++ Library
Library Version: 2312 R0
Documentation generated by doxygen
Public Methods | Private Methods | List of all members
ReportWriterStdIO Class Reference

#include <report.hpp>

Inheritance diagram for ReportWriterStdIO:
[legend]
Collaboration diagram for ReportWriterStdIO:
[legend]

Class Description


The standard ReportWriter writing the message to std::cout and std::cerr. The global formatter singleton is used is used to process the objects in the report message. This is by default of type FormatterPythonStyle. See method * Formatter::GetDefault for more information.

Friends

class Singleton<ReportWriterStdIO> class Report

Definition at line 273 of file report.hpp.

Public Methods

virtual ALIB_API void NotifyActivation (Phase phase) override
 
virtual ALIB_API void Report (Message &msg) override
 
- Public Methods inherited from ReportWriter
virtual ~ReportWriter ()
 
- Public Methods inherited from Singleton< TDerivedClass >
virtual ~Singleton ()
 

Private Methods

ALIB_API ReportWriterStdIO ()
 

Additional Inherited Members

- Public Static Methods inherited from Singleton< TDerivedClass >
static TDerivedClass & GetSingleton ()
 
- Protected Static Fields inherited from Singleton< TDerivedClass >
static TDerivedClass * singleton = nullptr
 

Constructor & Destructor Documentation

◆ ReportWriterStdIO()

ALIB_API ReportWriterStdIO ( )
inlineprivate

Private constructor, while parent class Singleton is friend. Therefore, only one instance may exist.

Definition at line 286 of file report.hpp.

Member Function Documentation

◆ NotifyActivation()

void NotifyActivation ( Phase  phase)
overridevirtual

Notify activation/deactivation

Parameters
phaseInformation if activated or deactivated.

Implements ReportWriter.

Definition at line 165 of file report.cpp.

Here is the call graph for this function:

◆ Report()

void Report ( Message msg)
overridevirtual

Writes the prefix "ALib Report (Error):" (respectively "ALib Report (Warning):" and the error message to the cout. On Windows platform, if a debugger is present, the message is also written using OutputDebugStringA.

If the first member of msg is of type string and it's contents follow the rules given with (higher level) module ALib in respect to valid domain path detection then this string is followed by a colon and a space (": ") to separate this "topic" from the rest of the message.

Parameters
msgThe message to report.

Implements ReportWriter.

Definition at line 178 of file report.cpp.

Here is the call graph for this function:

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