ALib C++ Library
Library Version: 2412 R0
Documentation generated by doxygen
Loading...
Searching...
No Matches
ReportWriterStdIO Class Reference

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 static field * Formatter::Default for more information.

Friends

class Singleton<ReportWriterStdIO> class Report

Definition at line 272 of file report.hpp.

#include <report.hpp>

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

Public Method Index:

virtual void NotifyActivation (lang::Phase) override
 Notify activation/deactivation.
 
virtual ALIB_API void Report (Message &msg) override
 
- Public Method Index: inherited from ReportWriter
virtual ~ReportWriter ()
 Virtual destructor.
 
- Public Method Index: inherited from Singleton< TDerivedClass >
virtual ~Singleton ()
 Virtual destructor.
 

Private Method Index:

 ReportWriterStdIO ()=default
 
virtual ~ReportWriterStdIO () override=default
 Private destructor.
 

Additional Inherited Members

- Public Static Method Index: inherited from Singleton< TDerivedClass >
static TDerivedClass & GetSingleton ()
 
- Protected Static Field Index: inherited from Singleton< TDerivedClass >
static TDerivedClass * singleton = nullptr
 A pointer to the one and only singleton.
 

Constructor(s) / Destructor Details:

◆ ReportWriterStdIO()

ReportWriterStdIO ( )
privatedefault

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

Method Details:

◆ NotifyActivation()

virtual void NotifyActivation ( lang::Phase )
inlineoverridevirtual

Notify activation/deactivation.

Implements ReportWriter.

Definition at line 292 of file report.hpp.

◆ 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 153 of file report.cpp.

Here is the call graph for this function:

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