LogFilterInterface.h

Classes

LogFilterInterface -- Abstract base class for filtering LogMessages. (full description)

class LogFilterInterface

Interface

Public Members
LogFilterInterface()
virtual ~LogFilterInterface()
virtual LogFilterInterface* clone() const = 0
virtual Bool pass (const LogMessage& message) const = 0
Private Members
LogFilterInterface (const LogFilterInterface& other)
LogFilterInterface& operator= (const LogFilterInterface& other)

Description

Review Status

Reviewed By:
wbrouw
Date Reviewed:
1996/08/21
Programs:
Demos:
Tests:

Prerequisite

Etymology

Log[Message] Filter.

Synopsis

The LogFilter class is used by the various log sink classes, typically accessed through LogSink, to decide whether a particular LogMessage should be accepted or rejected.

Simple filtering is based on the messages priority. In particular, you typically will choose to only pass messages greater than or equal to NORMAL in priority, but you might choose DEBUGGING to see all messages, or SEVERE to only see messages that report serious problems.

Example

Suppose we wanted to change the global sink so that it prints all messages, including debugging messages:
    LogFilter all(LogMessage::DEBUGGING);
    LogSink::globalSink().filter(all);
    

Motivation

Member Description

LogFilterInterface()

Construct a filter with the LOWEST priority that you want passed. Thus DEBUGGING passes everything. Note that it is not possible to block SEVERE level messages, although you can use a NullLogSink which will have this effect.

virtual ~LogFilterInterface()

virtual LogFilterInterface* clone() const = 0

Clone the object.

virtual Bool pass (const LogMessage& message) const = 0

Return True if message passes this filter.

LogFilterInterface (const LogFilterInterface& other)
LogFilterInterface& operator= (const LogFilterInterface& other)

Copy constructor and assignment cannot be used.