flashmatch::logger Class Reference

Utility class used to show formatted message on the screen. A logger class for flashmatch. Simply shows a formatted colored message on a screen.
A static getter method is provided to create a sharable logger instance (see OpT0FinderBase for useage).
. More...

#include <OpT0FinderLogger.h>

Public Member Functions
	logger (const std::string &name="no_name")
	Default constructor. More...
virtual	~logger ()
	Default destructor. More...
const std::string &	name () const
	Logger's name. More...
void	set (const msg::Level_t level)
	Verbosity level setter. More...
msg::Level_t	level () const
	Verbosity level getter. More...
bool	operator< (const logger &rhs) const
	Comparison operator for static collection of loggers. More...
bool	debug () const
bool	info () const
bool	normal () const
bool	warning () const
bool	error () const
std::ostream &	send (const msg::Level_t) const
	Formatted message (simplest) More...
std::ostream &	send (const msg::Level_t level, const std::string &function) const
	Formatted message (function name included) More...
std::ostream &	send (const msg::Level_t level, const std::string &function, const unsigned int line_num) const
	Formatted message (function name + line number) More...
std::ostream &	send (const msg::Level_t level, const std::string &function, const unsigned int line_num, const std::string &file_name) const
	Formatted message (function name + line number + file name) More...

Static Public Member Functions
static logger &	get (const std::string name)
	Getter of a message instance. More...
static msg::Level_t	default_level ()
	Default logger level getter. More...
static void	default_level (msg::Level_t l)
	Default logger level setter (only affect future loggers) More...
static void	force_level (msg::Level_t l)
	Force all loggers to change level. More...

Private Attributes
std::ostream *	_ostrm
	ostream More...
msg::Level_t	_level
	Level. More...
std::string	_name
	Name. More...

Static Private Attributes
static std::map< std::string, flashmatch::logger > *	_logger_m = nullptr
	Set of loggers. More...
static msg::Level_t	_level_default = msg::kNORMAL
	Default logger level. More...

Detailed Description

Utility class used to show formatted message on the screen. A logger class for flashmatch. Simply shows a formatted colored message on a screen.
A static getter method is provided to create a sharable logger instance (see OpT0FinderBase for useage).
.

Definition at line 30 of file OpT0FinderLogger.h.

Constructor & Destructor Documentation

flashmatch::logger::logger ( const std::string &  name = "no_name" )

inline

Default constructor.

Definition at line 35 of file OpT0FinderLogger.h.

      : _ostrm(&std::cout)
      , _name(name)
    {}

virtual flashmatch::logger::~logger ( )

inlinevirtual

Default destructor.

Definition at line 41 of file OpT0FinderLogger.h.

{};

Member Function Documentation

bool flashmatch::logger::debug ( ) const

inline

Definition at line 105 of file OpT0FinderLogger.h.

{ return _level <= msg::kDEBUG;   }

static msg::Level_t flashmatch::logger::default_level ( )

inlinestatic

Default logger level getter.

Definition at line 92 of file OpT0FinderLogger.h.

{ return _level_default; }

static void flashmatch::logger::default_level ( msg::Level_t  l )

inlinestatic

Default logger level setter (only affect future loggers)

Definition at line 94 of file OpT0FinderLogger.h.

{ _level_default = l; }

bool flashmatch::logger::error ( ) const

inline

Definition at line 109 of file OpT0FinderLogger.h.

{ return _level <= msg::kERROR;   }

static void flashmatch::logger::force_level ( msg::Level_t  l )

inlinestatic

Force all loggers to change level.

Definition at line 96 of file OpT0FinderLogger.h.

    {
      default_level(l);
      for(auto& name_logger : *_logger_m) name_logger.second.set(l);
    }

static logger& flashmatch::logger::get ( const std::string  name )

inlinestatic

Getter of a message instance.

Definition at line 80 of file OpT0FinderLogger.h.

    {
      if(!_logger_m) _logger_m = new std::map<std::string,flashmatch::logger>();
      auto iter = _logger_m->find(name);
      if(iter == _logger_m->end()) {
        iter = _logger_m->emplace(name,logger(name)).first;
        iter->second.set(msg::kNORMAL);
      }
      return iter->second;
    };

bool flashmatch::logger::info ( ) const

inline

Definition at line 106 of file OpT0FinderLogger.h.

{ return _level <= msg::kINFO;    }

msg::Level_t flashmatch::logger::level ( ) const

inline

Verbosity level getter.

Definition at line 69 of file OpT0FinderLogger.h.

{ return _level; }

const std::string& flashmatch::logger::name ( ) const

inline

Logger's name.

Definition at line 63 of file OpT0FinderLogger.h.

{ return _name; }

bool flashmatch::logger::normal ( ) const

inline

Definition at line 107 of file OpT0FinderLogger.h.

{ return _level <= msg::kNORMAL;  }

bool flashmatch::logger::operator< ( const logger &  rhs ) const

inline

Comparison operator for static collection of loggers.

Definition at line 72 of file OpT0FinderLogger.h.

    {
      if(_name < rhs.name()) return true;
      if(_name > rhs.name()) return false;
      return false;
    }

std::ostream & flashmatch::logger::send

(

const msg::Level_t

level

)

const

Formatted message (simplest)

Definition at line 11 of file OpT0FinderLogger.cxx.

  {
    (*_ostrm)  << msg::kStringPrefix[level].c_str()
               << "\033[0m ";
    return (*_ostrm);
  }

std::ostream & flashmatch::logger::send	(	const msg::Level_t	level,
		const std::string &	function
	)		const

Formatted message (function name included)

Definition at line 18 of file OpT0FinderLogger.cxx.

  {
    auto& strm(send(level));
    strm << "\033[94m<" << _name << "::" << function.c_str() << ">\033[00m ";
    return strm;
  }

std::ostream & flashmatch::logger::send	(	const msg::Level_t	level,
		const std::string &	function,
		const unsigned int	line_num
	)		const

Formatted message (function name + line number)

Definition at line 26 of file OpT0FinderLogger.cxx.

  {
    auto& strm(send(level));
    strm << "\033[94m<" << _name << "::" << function.c_str() << "::L" << line_num << ">\033[00m ";
    return strm;
  }

std::ostream & flashmatch::logger::send	(	const msg::Level_t	level,
		const std::string &	function,
		const unsigned int	line_num,
		const std::string &	file_name
	)		const

Formatted message (function name + line number + file name)

Definition at line 35 of file OpT0FinderLogger.cxx.

  {
    auto& strm(send(level,function));
    // FIXME temporary operation to fetch file name from full path
    strm << file_name.substr(file_name.rfind("/")+1,file_name.size()).c_str() << "::L" << line_num << " ";
    return strm;
  }

void flashmatch::logger::set ( const msg::Level_t  level )

inline

Verbosity level setter.

Definition at line 66 of file OpT0FinderLogger.h.

{ _level = level; }

bool flashmatch::logger::warning ( ) const

inline

Definition at line 108 of file OpT0FinderLogger.h.

{ return _level <= msg::kWARNING; }

Member Data Documentation

msg::Level_t flashmatch::logger::_level

private

Level.

Definition at line 49 of file OpT0FinderLogger.h.

msg::Level_t flashmatch::logger::_level_default = msg::kNORMAL

staticprivate

Default logger level.

Definition at line 58 of file OpT0FinderLogger.h.

std::map< std::string, logger > * flashmatch::logger::_logger_m = nullptr

staticprivate

Set of loggers.

Definition at line 55 of file OpT0FinderLogger.h.

std::string flashmatch::logger::_name

private

Name.

Definition at line 52 of file OpT0FinderLogger.h.

std::ostream* flashmatch::logger::_ostrm

private

ostream

Definition at line 41 of file OpT0FinderLogger.h.

---

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

• OpT0FinderLogger.h
• OpT0FinderLogger.cxx