LoggerManager class Responsible for configuring logger for a given application. More...

#include <LoggerManager.h>

Public Types
using	Logger = Logging::Logger

Public Types inherited from marlinmt::Component
using	LoggerPtr = Logging::Logger

Public Types inherited from marlinmt::Configurable
using	ParameterMap = std::map< std::string, std::shared_ptr< ParameterImpl > >

using	iterator = ParameterMap::iterator

using	const_iterator = ParameterMap::const_iterator

Public Member Functions
	LoggerManager (const LoggerManager &)=delete

LoggerManager &	operator= (const LoggerManager &)=delete

	~LoggerManager ()=default

	LoggerManager ()
	Constructor. More...

void	initialize () override
	Initialize the logger manager. More...

Logger	mainLogger () const
	Get the main logger instance (not the global one) More...

Logger	createLogger (const std::string &name) const
	Create a new logger instance. More...

Public Member Functions inherited from marlinmt::Component
	Component ()=delete
	No default constructor. More...

	Component (const Component &)=delete
	No copy or assignement. More...

Component &	operator= (const Component &)=delete

virtual	~Component ()=default
	Default destructor. More...

	Component (const std::string &type)
	Constructor with component type. More...

const std::string &	type () const
	Get the component name. More...

const std::string &	name () const
	Get the component name. More...

void	setName (const std::string &n)
	Set the component name. More...

const std::string &	description () const
	Get the component description. More...

void	setDescription (const std::string &desc)
	Set the component description. More...

const Application &	application () const
	Get the application in which the component is registered. More...

Application &	application ()
	Get the application in which the component is registered. More...

template<class T >
Logging::StreamType	log () const
	Log a message with specific log level. More...

Logging::StreamType	debug () const
	Shortcut for log<DEBUG>() More...

Logging::StreamType	message () const
	Shortcut for log<MESSAGE>() More...

Logging::StreamType	warning () const
	Shortcut for log<WARNING>() More...

Logging::StreamType	error () const
	Shortcut for log<ERROR>() More...

void	setVerbosity (const std::string &level)
	Set the verbosity level. More...

const std::string &	verbosity () const
	Get the verbosity level. More...

bool	isInitialized () const
	Whether the component has been initialized. More...

void	setup (Application *app)
	Setup the component. More...

void	printParameters () const
	Print the component parameters. More...

template<class T >
void	printParameters () const
	Print the component parameters at specific verbosity. More...

void	setParameters (const ConfigSection &section, bool throwIfNotFound=false)
	Set the parameters from the configuration section. More...

void	getParameters (ConfigSection &section, const std::set< std::string > &exclude={}) const
	Get the parameters from configurable object and populate the config section with. More...

Public Member Functions inherited from marlinmt::Configurable
	Configurable ()=default

virtual	~Configurable ()=default

template<typename T >
std::shared_ptr< ParameterImpl >	addParameter (EParameterType paramType, const std::string &name, const std::string &desc, std::shared_ptr< T > value)
	Add a parameter. More...

template<typename T >
std::shared_ptr< ParameterImpl >	addParameter (EParameterType paramType, const std::string &name, const std::string &desc, std::shared_ptr< T > value, T defVal)
	Add a parameter. More...

template<typename T >
T	parameter (const std::string &name) const
	Get a parameter value. More...

template<typename T >
T	parameter (const std::string &name, const T &fallback) const
	Get a parameter value. More...

void	checkParameter (const std::string &name) const
	Check if the parameter has been registered. More...

bool	exists (const std::string &name) const
	Return true if the parameter has been registered. More...

bool	isSet (const std::string &name) const
	Returns true if the parameter exists and is set, false otherwise. More...

void	clear ()
	Remove all parameters. More...

void	unset ()
	Unset all registered parameters. More...

iterator	begin ()

const_iterator	begin () const

iterator	end ()

const_iterator	end () const

Private Attributes
StringParameter	_logfile {*this, "Logfile", "The name of the log file", "" }
	The name of the log file (optional) More...

BoolParameter	_coloredConsole {*this, "ColoredConsole", "Whether to use a colored console printout", false }
	Whether to use a colored console printout. More...

Additional Inherited Members
Protected Attributes inherited from marlinmt::Component
std::string	_type {}
	The component type. More...

std::string	_name {}
	The component name. More...

std::string	_description {"No description"}
	The component description. More...

Application *	_application {nullptr}
	The application in which the component has been registered. More...

LoggerPtr	_logger {nullptr}
	The logger instance. More...

StringParameter	_verbosity { *this, "Verbosity", "The component verbosity level", "MESSAGE" }
	The verbosity level of the logger (parameter) More...

Protected Attributes inherited from marlinmt::Configurable
ParameterMap	_parameters {}
	The parameter map. More...

Detailed Description

LoggerManager class Responsible for configuring logger for a given application.

Can possibly configure the global logger instance.

Definition at line 21 of file LoggerManager.h.

Member Typedef Documentation

◆ Logger

using marlinmt::LoggerManager::Logger = Logging::Logger

Definition at line 23 of file LoggerManager.h.

Constructor & Destructor Documentation

◆ LoggerManager() [1/2]

marlinmt::LoggerManager::LoggerManager ( const LoggerManager & )

delete

◆ ~LoggerManager()

marlinmt::LoggerManager::~LoggerManager ( )

default

◆ LoggerManager() [2/2]

marlinmt::LoggerManager::LoggerManager ( )

Constructor.

Definition at line 8 of file LoggerManager.cc.

References mainLogger(), and marlinmt::Component::setDescription().

Member Function Documentation

◆ createLogger()

LoggerManager::Logger marlinmt::LoggerManager::createLogger ( const std::string & name ) const

Create a new logger instance.

The logger shares the same sinks as the main logger

Parameters

name	the logger name

Definition at line 47 of file LoggerManager.cc.

References marlinmt::Logging::createLogger(), and mainLogger().

◆ initialize()

void marlinmt::LoggerManager::initialize ( )

overridevirtual

Initialize the logger manager.

Reimplemented from marlinmt::Component.

Definition at line 17 of file LoggerManager.cc.

References _coloredConsole, _logfile, marlinmt::Component::application(), marlinmt::Application::configuration(), marlinmt::ParameterBase< T >::get(), mainLogger(), and marlinmt::Component::setParameters().

◆ mainLogger()

LoggerManager::Logger marlinmt::LoggerManager::mainLogger ( ) const

Get the main logger instance (not the global one)

Definition at line 41 of file LoggerManager.cc.

References marlinmt::Component::_logger.

Referenced by createLogger(), initialize(), and LoggerManager().

◆ operator=()

LoggerManager& marlinmt::LoggerManager::operator= ( const LoggerManager & )

delete

Member Data Documentation

◆ _coloredConsole

BoolParameter marlinmt::LoggerManager::_coloredConsole {*this, "ColoredConsole", "Whether to use a colored console printout", false }

private

Whether to use a colored console printout.

Definition at line 57 of file LoggerManager.h.

Referenced by initialize().

◆ _logfile

StringParameter marlinmt::LoggerManager::_logfile {*this, "Logfile", "The name of the log file", "" }