framework::logging::Formatter Class Reference

Our logging formatter. More...

#include <Logger.h>

Public Member Functions
	Formatter (Formatter const &)=delete
	delete the copy constructor
void	operator= (Formatter const &)=delete
	delete the assignment operator
void	operator() (const log::record_view &view, log::formatting_ostream &os)
	format the passed record view into the output stream

Static Public Member Functions
static Formatter &	get ()
	get reference to the current single Formatter
static void	set (int n)
	set the event number in the current Formatter

Private Attributes
int	event_number_ {0}

Detailed Description

Our logging formatter.

We use a singleton formatter so that it can hold the current event index_ as an attribute and include it within the logs. This is easier than attempting to update the event number in all of the different logging sources floating around ldmx-sw.

Definition at line 94 of file Logger.h.

Member Function Documentation

get()

Formatter & framework::logging::Formatter::get ( )

static

get reference to the current single Formatter

Definition at line 153 of file Logger.cxx.

                          {
  static Formatter the_formatter;
  return the_formatter;
}

Referenced by set().

operator()()

void framework::logging::Formatter::operator()	(	const log::record_view &	view,
		log::formatting_ostream &	os )

format the passed record view into the output stream

The format is

[ channel ] severity : message

We de-reference the value out of the log into our own type so that we can compare and convert it into a string.

Definition at line 160 of file Logger.cxx.

                                                      {
  os << "[ " << log::extract<std::string>("Channel", view) << " ] "
     << event_number_ << " ";
  const level msg_level{safeExtract<level>(view["Severity"])};
  switch (msg_level) {
    case level::trace:
      os << "trace";
      break;
    case level::debug:
      os << "debug";
      break;
    case level::info:
      os << " info";
      break;
    case level::warn:
      os << " warn";
      break;
    case level::error:
      os << "error";
      break;
    case level::fatal:
      os << "fatal";
      break;
    default:
      // this should never happen since the loggers created
      // with makeLogger use the level enum and thus check
      // at compile time that the given level is an good option.
      // That being said, we leave this in case someone creates
      // their own logger circumventing makeLogger for whatever
      // reason and changes the enum defining the severity.
      os << "?????";
      break;
  }
  os << ": " << view[log::expressions::smessage];
}

set()

void framework::logging::Formatter::set ( int n )

static

set the event number in the current Formatter

Definition at line 158 of file Logger.cxx.

{ Formatter::get().event_number_ = n; }

References get().

Referenced by framework::Process::run().

Member Data Documentation

event_number_

int framework::logging::Formatter::event_number_ {0}

private

Definition at line 95 of file Logger.h.

{0};

---

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

• Framework/include/Framework/Logger.h
• Framework/src/Framework/Logger.cxx