tarch::logging::LogFilter::FilterListEntry Struct Reference

Represents one entry of the filter list. More...

#include <LogFilter.h>

Collaboration diagram for tarch::logging::LogFilter::FilterListEntry:

Public Member Functions
bool	operator< (const FilterListEntry &b) const
bool	operator== (const FilterListEntry &b) const
bool	operator!= (const FilterListEntry &b) const
	FilterListEntry (const std::string &targetName="", bool isBlackListEntry=false)
	Construct filter list entry for one target without any.
	FilterListEntry (const std::string &targetName, int rank, const std::string &className, bool isBlackListEntry, const std::string &programPhase)
std::string	toString () const

Data Fields
std::string	_targetName
	The message type target can be either "debug" or "info".
int	_rank
	Sometimes, one wants to block all log entries of one namespace of one node (parallel case).
std::string	_namespaceName
	Name of the namespace that should not be logged.
bool	_isBlackEntry
	If true, filter list entry is a filter list entry, otherwise white list.
std::string	_programPhase
	AlwaysOn if the filter entry applies for all phases.

Static Public Attributes
static const int	AnyRank
static const std::string	TargetAll
static const std::string	TargetInfo
static const std::string	TargetDebug
static const std::string	TargetTrace
static const std::string	TargetWarning
static const std::string	AlwaysOn
static const bool	BlackListEntry
static const bool	WhiteListEntry

Detailed Description

Represents one entry of the filter list.

Syntax:

<log-filter target="debug" component="component-name" rank="int|*" switch="on|off" />

Definition at line 30 of file LogFilter.h.

Constructor & Destructor Documentation

FilterListEntry() [1/2]

tarch::logging::LogFilter::FilterListEntry::FilterListEntry	(	const std::string &	targetName = "",
		bool	isBlackListEntry = false )

Construct filter list entry for one target without any.

FilterListEntry() [2/2]

tarch::logging::LogFilter::FilterListEntry::FilterListEntry	(	const std::string &	targetName,
		int	rank,
		const std::string &	className,
		bool	isBlackListEntry,
		const std::string &	programPhase )

Member Function Documentation

operator!=()

bool tarch::logging::LogFilter::FilterListEntry::operator!=

(

const FilterListEntry &

b

)

const

operator<()

bool tarch::logging::LogFilter::FilterListEntry::operator<

(

const FilterListEntry &

b

)

const

operator==()

bool tarch::logging::LogFilter::FilterListEntry::operator==

(

const FilterListEntry &

b

)

const

toString()

std::string tarch::logging::LogFilter::FilterListEntry::toString

(

)

const

Field Documentation

_isBlackEntry

bool tarch::logging::LogFilter::FilterListEntry::_isBlackEntry

If true, filter list entry is a filter list entry, otherwise white list.

Definition at line 68 of file LogFilter.h.

_namespaceName

std::string tarch::logging::LogFilter::FilterListEntry::_namespaceName

Name of the namespace that should not be logged.

Definition at line 63 of file LogFilter.h.

_programPhase

std::string tarch::logging::LogFilter::FilterListEntry::_programPhase

AlwaysOn if the filter entry applies for all phases.

Otherwise, it only applies for a specific phase.

Definition at line 74 of file LogFilter.h.

_rank

int tarch::logging::LogFilter::FilterListEntry::_rank

Sometimes, one wants to block all log entries of one namespace of one node (parallel case).

In this case _rank holds the corresponding entry, if all entries from one namespace have to be blocked, the value of _rank equals AnyRank.

Definition at line 58 of file LogFilter.h.

_targetName

std::string tarch::logging::LogFilter::FilterListEntry::_targetName

The message type target can be either "debug" or "info".

Only messages with corresponding target are filtered by the FilterListEntry.

If left blank, all message types are targeted.

Definition at line 50 of file LogFilter.h.

AlwaysOn

const std::string tarch::logging::LogFilter::FilterListEntry::AlwaysOn

static

Definition at line 39 of file LogFilter.h.

AnyRank

const int tarch::logging::LogFilter::FilterListEntry::AnyRank

static

Definition at line 31 of file LogFilter.h.

BlackListEntry

const bool tarch::logging::LogFilter::FilterListEntry::BlackListEntry

static

Definition at line 41 of file LogFilter.h.

TargetAll

const std::string tarch::logging::LogFilter::FilterListEntry::TargetAll

static

Definition at line 33 of file LogFilter.h.

TargetDebug

const std::string tarch::logging::LogFilter::FilterListEntry::TargetDebug

static

Definition at line 35 of file LogFilter.h.

TargetInfo

const std::string tarch::logging::LogFilter::FilterListEntry::TargetInfo

static

Definition at line 34 of file LogFilter.h.

TargetTrace

const std::string tarch::logging::LogFilter::FilterListEntry::TargetTrace

static

Definition at line 36 of file LogFilter.h.

TargetWarning

const std::string tarch::logging::LogFilter::FilterListEntry::TargetWarning

static

Definition at line 37 of file LogFilter.h.

WhiteListEntry

const bool tarch::logging::LogFilter::FilterListEntry::WhiteListEntry

static

Definition at line 42 of file LogFilter.h.

---

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

• src/tarch/logging/LogFilter.h