Kratos::LoggerOutput Class Reference

LoggerOutput is the base class for all logger outputs. More...

#include <logger_output.h>

Inheritance diagram for Kratos::LoggerOutput:

Collaboration diagram for Kratos::LoggerOutput:

Public Member Functions
Type Definitions
	KRATOS_DEFINE_LOCAL_FLAG (WARNING_PREFIX)
	KRATOS_DEFINE_LOCAL_FLAG (INFO_PREFIX)
	KRATOS_DEFINE_LOCAL_FLAG (DETAIL_PREFIX)
	KRATOS_DEFINE_LOCAL_FLAG (DEBUG_PREFIX)
	KRATOS_DEFINE_LOCAL_FLAG (TRACE_PREFIX)
	KRATOS_CLASS_POINTER_DEFINITION (LoggerOutput)
	Pointer definition of LoggerOutput. More...
Life Cycle
	LoggerOutput (std::ostream &rOutputStream)
	LoggerOutput (LoggerOutput const &Other)
virtual	~LoggerOutput ()
	Destructor. More...
Operators
LoggerOutput &	operator= (LoggerOutput const &Other)=delete
Access
virtual void	WriteHeader ()
virtual void	WriteMessage (LoggerMessage const &TheMessage)
virtual void	Flush ()
void	SetMaxLevel (std::size_t TheLevel)
std::size_t	GetMaxLevel () const
void	SetSeverity (LoggerMessage::Severity const &TheSeverity)
LoggerMessage::Severity	GetSeverity () const
void	SetCategory (LoggerMessage::Category const &TheCategory)
LoggerMessage::Category	GetCategory () const
void	SetOption (const Kratos::Flags ThisFlag, bool Value)
bool	GetOption (const Kratos::Flags ThisFlag)
Input and output
virtual std::string	Info () const
	Turn back information as a string. More...
virtual void	PrintInfo (std::ostream &rOStream) const
	Print information about this object. More...
virtual void	PrintData (std::ostream &rOStream) const
	Print object's data. More...
template<class StreamValueType >
LoggerOutput &	operator<< (StreamValueType const &rValue)
	string stream function More...
LoggerOutput &	operator<< (std::ostream &(*pf)(std::ostream &))
	Manipulator stream function. More...
LoggerOutput &	operator<< (const char *rString)
	char stream function More...

Protected Member Functions
	LoggerOutput ()
std::ostream &	GetStream ()
std::ostream *	pGetStream ()
void	SetStream (std::ostream *pStream)
virtual void	SetMessageColor (LoggerMessage::Severity MessageSeverity)
virtual void	ResetMessageColor (LoggerMessage::Severity MessageSeverity)

Detailed Description

LoggerOutput is the base class for all logger outputs.

LoggerOutput defines the interface for all logger outputs and also provides the basic (and default) functionalities to be extended in other outputs

Constructor & Destructor Documentation

LoggerOutput() [1/3]

Kratos::LoggerOutput::LoggerOutput ( std::ostream &  rOutputStream )

inlineexplicit

LoggerOutput() [2/3]

Kratos::LoggerOutput::LoggerOutput ( LoggerOutput const &  Other )

inline

~LoggerOutput()

virtual Kratos::LoggerOutput::~LoggerOutput ( )

inlinevirtual

Destructor.

LoggerOutput() [3/3]

Kratos::LoggerOutput::LoggerOutput ( )

inlineprotected

Member Function Documentation

Flush()

void Kratos::LoggerOutput::Flush ( )

virtual

GetCategory()

LoggerMessage::Category Kratos::LoggerOutput::GetCategory ( ) const

inline

GetMaxLevel()

std::size_t Kratos::LoggerOutput::GetMaxLevel ( ) const

inline

GetOption()

bool Kratos::LoggerOutput::GetOption ( const Kratos::Flags  ThisFlag )

inline

GetSeverity()

LoggerMessage::Severity Kratos::LoggerOutput::GetSeverity ( ) const

inline

GetStream()

std::ostream& Kratos::LoggerOutput::GetStream ( )

inlineprotected

Info()

std::string Kratos::LoggerOutput::Info ( ) const

virtual

Turn back information as a string.

Reimplemented in Kratos::LoggerTableOutput, and Kratos::FileLoggerOutput.

KRATOS_CLASS_POINTER_DEFINITION()

Kratos::LoggerOutput::KRATOS_CLASS_POINTER_DEFINITION

(

LoggerOutput

)

Pointer definition of LoggerOutput.

KRATOS_DEFINE_LOCAL_FLAG() [1/5]

Kratos::LoggerOutput::KRATOS_DEFINE_LOCAL_FLAG

(

DEBUG_PREFIX

)

KRATOS_DEFINE_LOCAL_FLAG() [2/5]

Kratos::LoggerOutput::KRATOS_DEFINE_LOCAL_FLAG

(

DETAIL_PREFIX

)

KRATOS_DEFINE_LOCAL_FLAG() [3/5]

Kratos::LoggerOutput::KRATOS_DEFINE_LOCAL_FLAG

(

INFO_PREFIX

)

KRATOS_DEFINE_LOCAL_FLAG() [4/5]

Kratos::LoggerOutput::KRATOS_DEFINE_LOCAL_FLAG

(

TRACE_PREFIX

)

KRATOS_DEFINE_LOCAL_FLAG() [5/5]

Kratos::LoggerOutput::KRATOS_DEFINE_LOCAL_FLAG

(

WARNING_PREFIX

)

operator<<() [1/3]

LoggerOutput & Kratos::LoggerOutput::operator<<

(

const char *

rString

)

char stream function

operator<<() [2/3]

LoggerOutput & Kratos::LoggerOutput::operator<<

(

std::ostream &(*)(std::ostream &)

pf

)

Manipulator stream function.

operator<<() [3/3]

template<class StreamValueType >

LoggerOutput& Kratos::LoggerOutput::operator<< ( StreamValueType const &  rValue )

inline

string stream function

operator=()

LoggerOutput& Kratos::LoggerOutput::operator= ( LoggerOutput const &  Other )

delete

pGetStream()

std::ostream* Kratos::LoggerOutput::pGetStream ( )

inlineprotected

PrintData()

void Kratos::LoggerOutput::PrintData ( std::ostream &  rOStream ) const

virtual

Print object's data.

Reimplemented in Kratos::LoggerTableOutput.

PrintInfo()

void Kratos::LoggerOutput::PrintInfo ( std::ostream &  rOStream ) const

virtual

Print information about this object.

Reimplemented in Kratos::LoggerTableOutput.

ResetMessageColor()

void Kratos::LoggerOutput::ResetMessageColor ( LoggerMessage::Severity  MessageSeverity )

protectedvirtual

Reimplemented in Kratos::FileLoggerOutput.

SetCategory()

void Kratos::LoggerOutput::SetCategory ( LoggerMessage::Category const &  TheCategory )

inline

SetMaxLevel()

void Kratos::LoggerOutput::SetMaxLevel ( std::size_t  TheLevel )

inline

SetMessageColor()

void Kratos::LoggerOutput::SetMessageColor ( LoggerMessage::Severity  MessageSeverity )

protectedvirtual

Reimplemented in Kratos::FileLoggerOutput.

SetOption()

void Kratos::LoggerOutput::SetOption ( const Kratos::Flags  ThisFlag, bool  Value  )

inline

SetSeverity()

void Kratos::LoggerOutput::SetSeverity ( LoggerMessage::Severity const &  TheSeverity )

inline

SetStream()

void Kratos::LoggerOutput::SetStream ( std::ostream *  pStream )

inlineprotected

WriteHeader()

void Kratos::LoggerOutput::WriteHeader ( )

virtual

Reimplemented in Kratos::LoggerTableOutput.

WriteMessage()

void Kratos::LoggerOutput::WriteMessage ( LoggerMessage const &  TheMessage )

virtual

Reimplemented in Kratos::LoggerTableOutput.

---

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

• /home/runner/work/Documentation/Documentation/master/kratos/input_output/logger_output.h
• /home/runner/work/Documentation/Documentation/master/kratos/input_output/logger_output.cpp