List of all members | Public Member Functions | Public Attributes | Private Member Functions | Private Attributes
utl::MessageLoggerConfig Class Reference

Wraps a message to logger (received as parameter or created here), its access and configuration. More...

#include <Configuration/MessageLoggerConfig.h>

Public Member Functions

void ApplyConfiguration ()
 Apply already loaded configuration. More...
 
void Configure (const Branch &config)
 
const unsigned int & GetLevel () const
 Retrieve (read-only) the current level of verbosity. More...
 
unsigned int & GetLevel ()
 Retrieve by reference the current level of verbosity. More...
 
 MessageLoggerConfig (MessageLogger &l, const Branch &config)
 Create configurator with the logger to configure and the branch from where to load the configuration. More...
 
 MessageLoggerConfig (MessageLogger &l)
 Create configurator with the logger to configure. More...
 
 MessageLoggerConfig (const Branch &config)
 Create configurator given the branch from where to load the configuration. More...
 
 MessageLoggerConfig ()
 Create a configurator without any configuration yet. More...
 
template<typename T >
MessageLogger::Message operator() (const T &message, unsigned int level=0, bool trailEOL=true)
 
void SetLevel (unsigned int vl)
 Change the level of verbosity. More...
 

Public Attributes

template<class S >
void const
 Apply configuration to the given stream via manipulators. More...
 

Private Member Functions

void LoadConfiguration (const Branch &config)
 

Private Attributes

unsigned int fFlushPeriod = 0
 The period. More...
 
unsigned int fLevel = 0
 
unsigned int fNPrecDigits = 0
 Precission digits. More...
 
std::ofstream fOutput
 Output message sink. More...
 
std::string fOutputFilename
 Output log filename (if empty, then cout). More...
 
std::unique_ptr< MessageLoggerfOwnLogger
 Pointer to self created logger. More...
 
MessageLoggerfTheLogger
 The logger to configure. More...
 

Detailed Description

Wraps a message to logger (received as parameter or created here), its access and configuration.

Author
Rodolfo Federico Gamarra
Date
21 Sep 2009
See Also
MessageLogger

Definition at line 29 of file MessageLoggerConfig.h.

Constructor & Destructor Documentation

utl::MessageLoggerConfig::MessageLoggerConfig ( MessageLogger l,
const Branch config 
)

Create configurator with the logger to configure and the branch from where to load the configuration.

Definition at line 9 of file MessageLoggerConfig.cc.

References Configure().

utl::MessageLoggerConfig::MessageLoggerConfig ( MessageLogger l)

Create configurator with the logger to configure.

Definition at line 16 of file MessageLoggerConfig.cc.

utl::MessageLoggerConfig::MessageLoggerConfig ( const Branch config)

Create configurator given the branch from where to load the configuration.

Definition at line 21 of file MessageLoggerConfig.cc.

References Configure().

utl::MessageLoggerConfig::MessageLoggerConfig ( )

Create a configurator without any configuration yet.

Definition at line 29 of file MessageLoggerConfig.cc.

Member Function Documentation

void utl::MessageLoggerConfig::ApplyConfiguration ( )
void utl::MessageLoggerConfig::Configure ( const Branch config)
const unsigned int& utl::MessageLoggerConfig::GetLevel ( ) const
inline
unsigned int& utl::MessageLoggerConfig::GetLevel ( )
inline

Retrieve by reference the current level of verbosity.

Definition at line 53 of file MessageLoggerConfig.h.

References fLevel.

void utl::MessageLoggerConfig::LoadConfiguration ( const Branch config)
private

Definition at line 36 of file MessageLoggerConfig.cc.

References fFlushPeriod, fLevel, fNPrecDigits, fOutput, fOutputFilename, and utl::LoadConfig().

Referenced by Configure().

template<typename T >
MessageLogger::Message utl::MessageLoggerConfig::operator() ( const T &  message,
unsigned int  level = 0,
bool  trailEOL = true 
)
inline

Create a message for the given level.

See Also
utl::MessageLogger

Definition at line 62 of file MessageLoggerConfig.h.

References fTheLogger.

void utl::MessageLoggerConfig::SetLevel ( unsigned int  vl)
inline

Change the level of verbosity.

Definition at line 56 of file MessageLoggerConfig.h.

References fLevel.

Member Data Documentation

template<class S >
void utl::MessageLoggerConfig::const
Initial value:
{
fTheLogger.ApplyConfigurationOn(stream)

Apply configuration to the given stream via manipulators.

Definition at line 70 of file MessageLoggerConfig.h.

unsigned int utl::MessageLoggerConfig::fFlushPeriod = 0
private

The period.

Definition at line 90 of file MessageLoggerConfig.h.

Referenced by ApplyConfiguration(), and LoadConfiguration().

unsigned int utl::MessageLoggerConfig::fLevel = 0
private

Control how much output is generated.

See Also
utl::MessageLogger

Definition at line 84 of file MessageLoggerConfig.h.

Referenced by ApplyConfiguration(), GetLevel(), LoadConfiguration(), and SetLevel().

unsigned int utl::MessageLoggerConfig::fNPrecDigits = 0
private

Precission digits.

Definition at line 87 of file MessageLoggerConfig.h.

Referenced by ApplyConfiguration(), and LoadConfiguration().

std::ofstream utl::MessageLoggerConfig::fOutput
private

Output message sink.

Definition at line 93 of file MessageLoggerConfig.h.

Referenced by LoadConfiguration().

std::string utl::MessageLoggerConfig::fOutputFilename
private

Output log filename (if empty, then cout).

Definition at line 96 of file MessageLoggerConfig.h.

Referenced by LoadConfiguration().

std::unique_ptr<MessageLogger> utl::MessageLoggerConfig::fOwnLogger
private

Pointer to self created logger.

Definition at line 99 of file MessageLoggerConfig.h.

MessageLogger& utl::MessageLoggerConfig::fTheLogger
private

The logger to configure.

Definition at line 102 of file MessageLoggerConfig.h.

Referenced by ApplyConfiguration(), and operator()().


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

, generated on Tue Sep 26 2023.