casa  5.7.0-16
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Private Attributes | List of all members
casacore::LogFilter Class Reference

Filter LogMessages on message priority. More...

#include <LogFilter.h>

Inheritance diagram for casacore::LogFilter:
casacore::LogFilterInterface casa::LogFilterParallel

Public Member Functions

 LogFilter (LogMessage::Priority lowest=LogMessage::NORMAL)
 Construct a filter with the LOWEST priority that you want passed. More...
 
 LogFilter (const LogFilter &other)
 Copy other to this. More...
 
LogFilteroperator= (const LogFilter &other)
 
virtual ~LogFilter ()
 
virtual LogFilterclone () const
 Clone the object. More...
 
virtual Bool pass (const LogMessage &message) const
 Return True if message passes this filter. More...
 
LogMessage::Priority lowestPriority () const
 Return the lowest priority which will pass this filter. More...
 
- Public Member Functions inherited from casacore::LogFilterInterface
 LogFilterInterface ()
 Construct a filter with the LOWEST priority that you want passed. More...
 
virtual ~LogFilterInterface ()
 

Private Attributes

LogMessage::Priority lowest_p
 

Detailed Description

Filter LogMessages on message priority.

Intended use:

Public interface

Review Status

Reviewed By:
wbrouw
Date Reviewed:
1996/08/21
Test programs:
tLogging
Demo programs:
dLogging

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:

Motivation

Definition at line 84 of file LogFilter.h.

Constructor & Destructor Documentation

casacore::LogFilter::LogFilter ( LogMessage::Priority  lowest = LogMessage::NORMAL)

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.

casacore::LogFilter::LogFilter ( const LogFilter other)

Copy other to this.

virtual casacore::LogFilter::~LogFilter ( )
virtual

Member Function Documentation

virtual LogFilter* casacore::LogFilter::clone ( ) const
virtual

Clone the object.

Implements casacore::LogFilterInterface.

Reimplemented in casa::LogFilterParallel.

LogMessage::Priority casacore::LogFilter::lowestPriority ( ) const
inline

Return the lowest priority which will pass this filter.

Definition at line 116 of file LogFilter.h.

References lowest_p.

LogFilter& casacore::LogFilter::operator= ( const LogFilter other)
virtual Bool casacore::LogFilter::pass ( const LogMessage message) const
virtual

Return True if message passes this filter.

Implements casacore::LogFilterInterface.

Reimplemented in casa::LogFilterParallel.

Member Data Documentation

LogMessage::Priority casacore::LogFilter::lowest_p
private

Definition at line 112 of file LogFilter.h.

Referenced by lowestPriority().


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