tarch::logging::LogFilterFileReader Class Reference

Read log filter spec file. More...

#include <LogFilterFileReader.h>

Collaboration diagram for tarch::logging::LogFilterFileReader:

Static Public Member Functions
static bool	parsePlainTextFile (const std::string &filename)
	Tries to parse a simple text file where each line contains an entry.

Static Private Member Functions
static bool	interpretTokens (const std::string &levelToken, const std::string &classNameToken, const std::string &rankToken, const std::string &onOffToken, const std::string &phaseToken)
static bool	parseLine (std::ifstream &file, const std::string &filename, const std::string &line, int linenumber)
static std::string	trimLine (const std::string &line)

Static Private Attributes
static tarch::logging::Log	_log

Detailed Description

Read log filter spec file.

Very simple utility class offering a couple of static operations to parse different filter files for the command line logger. Each line specifies one filter list entry. Comment lines have to start with #. Here's an example for a valid configuration file:

\code
 
# Level (info or debug)   Trace   Rank (-1 means all ranks)   Black or white list entry
 
#
# General debug settings
#
debug  tarch                               -1     black
debug  peano                               -1     black
 
#
# General info settings
#
info  tarch                               -1     white
info  peano                               -1     white
 
info   my::full::qualified::class::name    -1     black
debug  my::full::qualified::class::name    43     white

Author

Tobias Weinzierl, Kristof Unterweger

Definition at line 49 of file LogFilterFileReader.h.

Member Function Documentation

interpretTokens()

static bool tarch::logging::LogFilterFileReader::interpretTokens ( const std::string &  levelToken, const std::string &  classNameToken, const std::string &  rankToken, const std::string &  onOffToken, const std::string &  phaseToken  )

staticprivate

Returns

Parsing has been successful

parseLine()

static bool tarch::logging::LogFilterFileReader::parseLine ( std::ifstream &  file, const std::string &  filename, const std::string &  line, int  linenumber  )

staticprivate

Returns

Parsing has been successful

parsePlainTextFile()

static bool tarch::logging::LogFilterFileReader::parsePlainTextFile ( const std::string &  filename )

static

Tries to parse a simple text file where each line contains an entry.

If the file does not exist or the parse did not succeed, the operation writes an error and returns false. Otherwise, it returns true.

If the routine fails, it switches on all log information automatically. If you want to create a (hard-coded) fall-back logging, you thus might have to call clearFilterList() again before you continue.

Returns

Parsing has been successful

trimLine()

static std::string tarch::logging::LogFilterFileReader::trimLine ( const std::string &  line )

staticprivate

Field Documentation

_log

tarch::logging::Log tarch::logging::LogFilterFileReader::_log

staticprivate

Definition at line 51 of file LogFilterFileReader.h.

---

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

• src/tarch/logging/LogFilterFileReader.h