tarch::logging::LogFilter Class Reference

Peano4's log filter is used by every single log instance. More...

#include <LogFilter.h>

Collaboration diagram for tarch::logging::LogFilter:

Data Structures
struct	FilterListEntry
	Represents one entry of the filter list. More...

Public Types
typedef std::set< FilterListEntry >	FilterList

Public Member Functions
	LogFilter ()
	By default, everything is on.
bool	filterOut (const std::string &targetName, const std::string &className)
	May not be const as it might write a warning itself.
	~LogFilter ()
void	addFilterListEntry (const FilterListEntry &entry)
	Add one filter list entry.
void	addFilterListEntries (const FilterList &entries)
void	clearFilterList ()
void	printFilterListToCout () const
bool	writeDebug (const std::string &trace)
bool	writeInfo (const std::string &trace)
bool	writeTrace (const std::string &trace)
bool	writeWarning (const std::string &trace)
void	switchProgramPhase (const std::string &activeProgramPhase)

Static Public Member Functions
static LogFilter &	getInstance ()

Data Fields
FilterList	_filterlist

Private Attributes
std::string	_activeProgramPhase

Detailed Description

Peano4's log filter is used by every single log instance.

Please note that the fourth generation of Peano allows users to filter only w.r.t. the class name. You can't filter on the method level anymore.

Definition at line 20 of file LogFilter.h.

Member Typedef Documentation

FilterList

typedef std::set<FilterListEntry> tarch::logging::LogFilter::FilterList

Definition at line 89 of file LogFilter.h.

Constructor & Destructor Documentation

LogFilter()

tarch::logging::LogFilter::LogFilter

(

)

By default, everything is on.

~LogFilter()

tarch::logging::LogFilter::~LogFilter

(

)

Member Function Documentation

addFilterListEntries()

void tarch::logging::LogFilter::addFilterListEntries

(

const FilterList &

entries

)

addFilterListEntry()

void tarch::logging::LogFilter::addFilterListEntry

(

const FilterListEntry &

entry

)

Add one filter list entry.

If you wanna switch on the logging globally, please add

tarch::logging::ChromeTraceFileLogger::getInstance().addFilterListEntry(tarch::logging::ChromeTraceFileLogger::FilterListEntry());

to your configuration.

clearFilterList()

void tarch::logging::LogFilter::clearFilterList

(

)

filterOut()

bool tarch::logging::LogFilter::filterOut	(	const std::string &	targetName,
		const std::string &	className )

May not be const as it might write a warning itself.

Is public as some analysis frameworks check explicitly whether these features are switched on.

getInstance()

static LogFilter & tarch::logging::LogFilter::getInstance ( )

static

printFilterListToCout()

void tarch::logging::LogFilter::printFilterListToCout

(

)

const

switchProgramPhase()

void tarch::logging::LogFilter::switchProgramPhase

(

const std::string &

activeProgramPhase

)

writeDebug()

bool tarch::logging::LogFilter::writeDebug

(

const std::string &

trace

)

writeInfo()

bool tarch::logging::LogFilter::writeInfo

(

const std::string &

trace

)

writeTrace()

bool tarch::logging::LogFilter::writeTrace

(

const std::string &

trace

)

writeWarning()

bool tarch::logging::LogFilter::writeWarning

(

const std::string &

trace

)

Field Documentation

_activeProgramPhase

std::string tarch::logging::LogFilter::_activeProgramPhase

private

Definition at line 22 of file LogFilter.h.

_filterlist

FilterList tarch::logging::LogFilter::_filterlist

Definition at line 91 of file LogFilter.h.

---

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

• src/tarch/logging/LogFilter.h