Medical Imaging Interaction Toolkit  2021.02.99-89548602
Medical Imaging Interaction Toolkit
mbilog::TextBackendBase Class Referenceabstract

This class is an abstract superclass for logging text backends. It adds string formatting methods to the backend interface BackendBase. Accordingly backends that inherit from this class can be registered in the mbi logging mechanism. More...

#include <mbilogTextBackendBase.h>

Inheritance diagram for mbilog::TextBackendBase:
Collaboration diagram for mbilog::TextBackendBase:

Public Member Functions

 ~TextBackendBase () override
 
void ProcessMessage (const mbilog::LogMessage &logMessage) override=0
 This method is called by the mbi logging mechanism if the object is registered in the mbi logging mechanism and a logging message is emitted. More...
 
- Public Member Functions inherited from mbilog::BackendBase
virtual ~BackendBase ()
 
virtual OutputType GetOutputType () const =0
 

Protected Member Functions

void FormatSmart (const LogMessage &l, int threadID=0)
 Method formats the given LogMessage in the smart/short format and writes it to std::cout. More...
 
void FormatFull (const LogMessage &l, int threadID=0)
 Method formats the given LogMessage in the full/long format and writes it to std::cout. More...
 
void FormatSmart (std::ostream &out, const LogMessage &l, int threadID=0)
 Method formats the given LogMessage in the smart/short format and writes it to the given std::ostream. More...
 
void FormatFull (std::ostream &out, const LogMessage &l, int threadID=0)
 Method formats the given LogMessage in the full/long format and writes it to the given std::ostream. More...
 
void AppendTimeStamp (std::ostream &out)
 Writes the system time to the given stream. More...
 
void FormatSmartWindows (const mbilog::LogMessage &l, int)
 Special variant of method FormatSmart which uses colored messages (only for windows). More...
 

Detailed Description

This class is an abstract superclass for logging text backends. It adds string formatting methods to the backend interface BackendBase. Accordingly backends that inherit from this class can be registered in the mbi logging mechanism.

Documentation

Definition at line 28 of file mbilogTextBackendBase.h.

Constructor & Destructor Documentation

◆ ~TextBackendBase()

mbilog::TextBackendBase::~TextBackendBase ( )
override

Member Function Documentation

◆ AppendTimeStamp()

void mbilog::TextBackendBase::AppendTimeStamp ( std::ostream &  out)
protected

Writes the system time to the given stream.

◆ FormatFull() [1/2]

void mbilog::TextBackendBase::FormatFull ( const LogMessage l,
int  threadID = 0 
)
protected

Method formats the given LogMessage in the full/long format and writes it to std::cout.

Parameters
l
threadIDCan be set to the threadID where the logging message was emitted. Is 0 by default.

◆ FormatFull() [2/2]

void mbilog::TextBackendBase::FormatFull ( std::ostream &  out,
const LogMessage l,
int  threadID = 0 
)
protected

Method formats the given LogMessage in the full/long format and writes it to the given std::ostream.

Parameters
out
l
threadIDCan be set to the threadID where the logging message was emitted. Is 0 by default.

◆ FormatSmart() [1/2]

void mbilog::TextBackendBase::FormatSmart ( const LogMessage l,
int  threadID = 0 
)
protected

Method formats the given LogMessage in the smart/short format and writes it to std::cout.

Parameters
l
threadIDCan be set to the threadID where the logging message was emitted. Is 0 by default.

◆ FormatSmart() [2/2]

void mbilog::TextBackendBase::FormatSmart ( std::ostream &  out,
const LogMessage l,
int  threadID = 0 
)
protected

Method formats the given LogMessage in the smart/short format and writes it to the given std::ostream.

Parameters
out
l
threadIDCan be set to the threadID where the logging message was emitted. Is 0 by default.

◆ FormatSmartWindows()

void mbilog::TextBackendBase::FormatSmartWindows ( const mbilog::LogMessage l,
int   
)
protected

Special variant of method FormatSmart which uses colored messages (only for windows).

◆ ProcessMessage()

void mbilog::TextBackendBase::ProcessMessage ( const mbilog::LogMessage logMessage)
overridepure virtual

This method is called by the mbi logging mechanism if the object is registered in the mbi logging mechanism and a logging message is emitted.

Parameters
logMessageLogging message which was emitted.

Implements mbilog::BackendBase.

Implemented in mbilog::BackendCout, and mitk::LoggingBackend.


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