casacore
Loading...
Searching...
No Matches
LogFilterTaql.h
Go to the documentation of this file.
1//# LogFilterTaql.h: Filter LogMessages using a TaQL expression
2//# Copyright (C) 1996,2000,2003
3//# Associated Universities, Inc. Washington DC, USA.
4//#
5//# This library is free software; you can redistribute it and/or modify it
6//# under the terms of the GNU Library General Public License as published by
7//# the Free Software Foundation; either version 2 of the License, or (at your
8//# option) any later version.
9//#
10//# This library is distributed in the hope that it will be useful, but WITHOUT
11//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13//# License for more details.
14//#
15//# You should have received a copy of the GNU Library General Public License
16//# along with this library; if not, write to the Free Software Foundation,
17//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18//#
19//# Correspondence concerning AIPS++ should be addressed as follows:
20//# Internet email: casa-feedback@nrao.edu.
21//# Postal address: AIPS++ Project Office
22//# National Radio Astronomy Observatory
23//# 520 Edgemont Road
24//# Charlottesville, VA 22903-2475 USA
25
26#ifndef TABLES_LOGFILTERTAQL_H
27#define TABLES_LOGFILTERTAQL_H
28
29//# Includes
30#include <casacore/casa/aips.h>
31#include <casacore/casa/Logging/LogFilterInterface.h>
32
33namespace casacore { //# NAMESPACE CASACORE - BEGIN
34
35//# Forward Declarations
36class LogFilterExpr;
37
38
39// <summary>
40// Filter LogMessages using a TaQL expression.
41// </summary>
42
43// <use visibility=export>
44
45// <reviewed reviewer="wbrouw" date="1996/08/21" tests="" demos="dLogging.cc" tests="tLogging.cc">
46// </reviewed>
47
48// <prerequisite>
49// <li> <linkto class="LogMessage">LogMessage</linkto>
50// </prerequisite>
51//
52// <etymology>
53// Log[Message] Filter.
54// </etymology>
55//
56// <synopsis>
57// The <src>LogFilter</src> class is used by the various log sink classes,
58// typically accessed through <linkto class="LogSink">LogSink</linkto>, to
59// decide whether a particular <linkto class="LogMessage">LogMessage</linkto>
60// should be accepted or rejected.
61//
62// Simple filtering is based on the messages priority.
63// In particular, you typically will choose to only pass messages greater
64// than or equal to <src>NORMAL</src> in priority, but you might choose
65// <src>DEBUGGING</src> to see all messages, or <src>SEVERE</src> to only see
66// messages that report serious problems.
67// </synopsis>
68//
69// <example>
70// Suppose we wanted to change the global sink so that it prints all messages,
71// including debugging messages:
72// <srcblock>
73// LogFilter all(LogMessage::DEBUGGING);
74// LogSink::globalSink().filter(all);
75// </srcblock>
76// </example>
77//
78// <motivation>
79// </motivation>
80//
81//# <todo asof="1996/07/23">
82//# </todo>
83
85{
86public:
87 // Construct a filter from a TaQL expression. Only messages matching
88 // the expression pass the filter.
89 // The field names that can be used in the expression are:
90 // TIME, PRIORITY, MESSAGE, LOCATION, OBJECT_ID.
91 // All fields are strings, expect for TIME which is a double (MJD in sec.).
92 explicit LogFilterTaql (const String& expr);
93
94 // Copy <src>other</src> to <src>this</src>.
95 // <group>
98 // </group>
99
100 virtual ~LogFilterTaql();
101
102 // Clone the object.
103 virtual LogFilterTaql* clone() const;
104
105 // Return True if <src>message</src> passes this filter.
106 virtual Bool pass (const LogMessage& message) const;
107
108private:
110};
111
112
113
114} //# NAMESPACE CASACORE - END
115
116#endif
LogFilterTaql(const String &expr)
Construct a filter from a TaQL expression.
LogFilterTaql & operator=(const LogFilterTaql &other)
virtual LogFilterTaql * clone() const
Clone the object.
LogFilterTaql(const LogFilterTaql &other)
Copy other to this.
virtual Bool pass(const LogMessage &message) const
Return True if message passes this filter.
String: the storage and methods of handling collections of characters.
Definition String.h:223
this file contains all the compiler specific defines
Definition mainpage.dox:28
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40