CategoryInformation Class Reference

#include <CategoryInformation.hh>

List of all members.

Detailed Description

Hold the internal information for each category.

A "Category" would be created for each different functional section of a program. They are created and destroyed only by the log manager to store information about each category throughout the lifetime of the logger. Each category has independent fitlerLevels, messageLevels, messageLevel stacks, and can be independently turned on or off.

Public Member Functions

std::string getCategoryName () const

Gets the name of the category.

bool isEnabled ()

Checks if category is enabled.

MessageLevel getFilterLevel () const

Gets the current filter level.

void setFilterLevel (MessageLevel filterLevel)

Sets the current filter level.

MessageLevel getMessageLevel () const

Gets the current message level.

void setMessageLevel (MessageLevel messageLevel)

Sets the message level.

void pushMessageLevel (MessageLevel messageLevel)

Pushes the current message level onto a stack, and sets a new messagelevel.

void popMessageLevel ()

Pops a message level off of a stack and sets that to be the new messagelevel.

bool doLog (MessageLevel messagelevel) const

Function to check that category is enabled and message is not filtered.

Friends

class Logger

Member Function Documentation

bool CategoryInformation::doLog ( MessageLevel messageLevel ) const

Function to check that category is enabled and message is not filtered.
A message will be logged if it's messagelevel is less than or equal to the filter level

Returns:
If message should be logged

std::string CategoryInformation::getCategoryName ( ) const

Gets the name of the category.

Returns:
Name of the category

MessageLevel CategoryInformation::getFilterLevel ( ) const

Gets the current filter level.

Returns:
Current filter Level

MessageLevel CategoryInformation::getMessageLevel ( ) const

Gets the current message level.

Returns:
Current message Level

bool CategoryInformation::isEnabled ( )

Checks if category is enabled.

void CategoryInformation::popMessageLevel ( )

Pops a message level off of a stack and sets that to be the new messagelevel.

See also:
pushMessageLevel

void CategoryInformation::pushMessageLevel ( MessageLevel messageLevel )

Pushes the current message level onto a stack, and sets a new messagelevel.

Parameters:

messageLevel Message level to set

See also:
popMessageLevel

void CategoryInformation::setFilterLevel ( MessageLevel filterLevel )

Sets the current filter level.

Parameters:

filterLevel New filter Level

void CategoryInformation::setMessageLevel ( MessageLevel messageLevel )

Sets the message level.

Parameters:

messageLevel New Message level

Friends And Related Function Documentation

friend class Logger [friend]

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