/usr/include/casacore/casa/Logging/LogSinkInterface.h is in casacore-dev 2.2.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 | //# LogSinkInterface.h: Accepts LogMessages and posts them to some destination
//# Copyright (C) 1996,2000,2001,2003
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//# Internet email: aips2-request@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
//#
//#
//# $Id$
#ifndef CASA_LOGSINKINTERFACE_H
#define CASA_LOGSINKINTERFACE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Logging/LogFilterInterface.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
//Accepts LogMessages and posts them to some destination
// </summary>
// <use visibility=local>
// <reviewed reviewer="wbrouw" date="1996/08/21" tests="tLogging.cc" demos="dLogging.cc">
// </reviewed>
// <prerequisite>
// <li> <linkto class=LogMessage>LogMessage</linkto>
// <li> <linkto class=LogFilterInterface>LogFilterInterface</linkto>
// </prerequisite>
//
// <etymology>
// Log as in "Log Book." Sink from its common usage ("source/sink") as a thing
// which can accept some substance or energy. Interface because this is an
// abstract, not concrete, class.
// </etymology>
//
// <synopsis>
// This abstract base class is not intended for applications programmers.
// Instead they should look at <linkto class=LogSink>LogSink</linkto>.
//
// This class defines a minimal "posting" interface for all objects which accept
// log messages. The fundamental model of a <src>LogSinkInterface</src> is:
// <ol>
// <li> That it contains a
// <linkto class=LogFilterInterface>LogFilterInterface</linkto> that is
// used to accept or reject messages; and
// <li> That it has a post message that takes a log message; and, if it passes
// the filter, does something with it (prints it to a stream, saves it to
// a table, ...).
// </ol>
// There is no notion of local vs global sinks - that is imposed by
// <src>LogSink</src>.
// </synopsis>
//
// <example>
// <srcblock>
// LogSinkInterface &ref = ...;
// LogMessage message(...);
// ref.postLocally(message);
// if (ref.filter().lowestPriority() != LogMessage::DEBUGGING) {
// ref.filter(LogMessage::DEBUGGING);
// }
// </srcblock>
// For a more complete example see <linkto file="Logging.h">Logging.h</linkto>.
// </example>
//
// <motivation>
// Make it straightforward to extend the number of places a message may be
// in the future through derivation.
// </motivation>
//
// <todo asof="1996/07/24">
// <li> Nothing known.
// </todo>
class LogSinkInterface
{
public:
// Create with a <src>NORMAL</src> filter.
LogSinkInterface();
// Create with the supplied <src>filter</src>.
LogSinkInterface(const LogFilterInterface &filter);
// Copy semantics - copy the filter from <src>other</src> to <src>this</src>
// <group>
LogSinkInterface(const LogSinkInterface &other);
LogSinkInterface &operator=(const LogSinkInterface &);
// </group>
virtual ~LogSinkInterface();
// Get/set the filter.
// <group>
virtual const LogFilterInterface &filter() const;
virtual LogSinkInterface &filter(const LogFilterInterface &filter);
// </group>
// Get number of messages in sink.
virtual uInt nelements() const;
// Get given part of the i-th message from the sink.
// <group>
virtual Double getTime (uInt i) const;
virtual String getPriority (uInt i) const;
virtual String getMessage (uInt i) const;
virtual String getLocation (uInt i) const;
virtual String getObjectID (uInt i) const;
// </group>
// This function must be over-ridden in derived classes. If the filter
// passes the message, do what is necessary with the message and return
// <src>True</src>.
virtual Bool postLocally(const LogMessage &message)= 0;
// Write any pending output.
virtual void flush (Bool global=True);
// Write a message (usually from another logsink) into the local one.
// The default implementation does nothing.
virtual void writeLocally (Double time, const String& message,
const String& priority, const String& location,
const String& objectID);
// Clear the local sink (i.e. remove all messages from it).
// The default implementation does nothing.
virtual void clearLocally();
// Returns the id for this class...
static String localId( );
// Returns the id of the LogSink in use...
virtual String id( ) const = 0;
// Write to cerr too
virtual void cerrToo(bool cerr2);
void setTaskName(const String &theTask){taskName=theTask;}
private:
LogFilterInterface* filter_p;
protected:
String taskName;
};
} //# NAMESPACE CASACORE - END
#endif
|