Loading...
Searching...
No Matches
StreamLogSink.h
Go to the documentation of this file.
//# StreamLogSink.h: Send log messages to an ostream.
//# 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef CASA_STREAMLOGSINK_H
#define CASA_STREAMLOGSINK_H
#include <casacore/casa/aips.h>
#include <casacore/casa/Logging/LogSinkInterface.h>
#include <casacore/casa/iosfwd.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
// <summary>
// Send log messages to an ostream.
// </summary>
// <use visibility=local>
// <reviewed reviewer="wbrouw" date="1996/08/21" tests="tLogging.cc" demos="dLogging.cc">
// </reviewed>
// <prerequisite>
// <li> <linkto class=LogSinkInterface>LogSinkInterface</linkto>
// <li> ostream
// </prerequisite>
//
// <etymology>
// "Stream" from the family of standard C++ I/O classes.
// </etymology>
//
// <synopsis>
// <src>StreamLogSink</src> is a straightforward
// <linkto class=LogSinkInterface>LogSinkInterface</linkto> which sends its
// messages to an <src>ostream</src> (typically <src>cerr</src>) which it is
// given at construction time. It is not intended to be used directly, rather it
// should be used through <linkto class=LogSink>LogSink</linkto>.
// </synopsis>
//
// <example>
// See <linkto file="Logging.h">Logging.h</linkto>.
// </example>
//
// <motivation>
// Writing to standard output or error will be a common way of displaying log
// messages.
// </motivation>
//
// <todo asof="1996/07/24">
// <li> Nothing known.
// </todo>
class StreamLogSink : public LogSinkInterface {
public:
// Defaults to <src>cerr</src> if no stream is supplied. The caller is
// responsible for ensuring that the supplied <src>ostream</src> ostream
// lives at least as long as this sink. If not filter is supplied,
// <src>NORMAL</src> is used.
// <group>
explicit StreamLogSink(ostream *theStream = 0, bool deleteStream = false);
explicit StreamLogSink(LogMessage::Priority filter,
ostream *theStream = 0, bool deleteStream = false);
explicit StreamLogSink(const LogFilterInterface &filter,
ostream *theStream = 0, bool deleteStream = false);
// </group>
// Make a copy of <src>other</src>. After copying, both objects will post
// to the same stream.
// <group>
StreamLogSink(const StreamLogSink &other);
StreamLogSink &operator=(const StreamLogSink &other);
// </group>
~StreamLogSink();
// Write <src>message</src> to the stream if it passes the filter. Works
// by calling <src>operator<<(ostream &,const LogMesssage&)</src>.
virtual Bool postLocally(const LogMessage &message);
// write any pending output.
virtual void flush (Bool global=True);
// Returns the id for this class...
static String localId( );
// Returns the id of the LogSink in use...
String id( ) const;
private:
ostream *stream_p;
bool deleteStream;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::LogFilterInterface
Definition LogFilterInterface.h:82
casacore::LogMessage
Definition LogMessage.h:98
casacore::LogMessage::Priority
Priority
An "importance" which is assigned to each LogMessage.
Definition LogMessage.h:102
casacore::LogSinkInterface::LogSinkInterface
LogSinkInterface()
Create with a NORMAL filter.
casacore::LogSinkInterface::filter
virtual const LogFilterInterface & filter() const
Get/set the filter.
casacore::StreamLogSink::flush
virtual void flush(Bool global=True)
write any pending output.
casacore::StreamLogSink::~StreamLogSink
~StreamLogSink()
casacore::StreamLogSink::postLocally
virtual Bool postLocally(const LogMessage &message)
Write message to the stream if it passes the filter.
casacore::StreamLogSink::stream_p
ostream * stream_p
Definition StreamLogSink.h:113
casacore::StreamLogSink::operator=
StreamLogSink & operator=(const StreamLogSink &other)
casacore::StreamLogSink::StreamLogSink
StreamLogSink(const StreamLogSink &other)
Make a copy of other.
casacore::StreamLogSink::StreamLogSink
StreamLogSink(const LogFilterInterface &filter, ostream *theStream=0, bool deleteStream=false)
casacore::StreamLogSink::deleteStream
bool deleteStream
Definition StreamLogSink.h:114
casacore::StreamLogSink::id
String id() const
Returns the id of the LogSink in use...
casacore::StreamLogSink::localId
static String localId()
Returns the id for this class...
casacore::StreamLogSink::StreamLogSink
StreamLogSink(ostream *theStream=0, bool deleteStream=false)
Defaults to cerr if no stream is supplied.
casacore::StreamLogSink::StreamLogSink
StreamLogSink(LogMessage::Priority filter, ostream *theStream=0, bool deleteStream=false)
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40
casacore::True
const Bool True
Definition aipstype.h:41