/usr/include/casacore/tables/LogTables/TableLogSink.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 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 | //# TableLogSink.h: Save log messages in a Casacore Table
//# Copyright (C) 1996,1997,1998,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 TABLES_TABLELOGSINK_H
#define TABLES_TABLELOGSINK_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/casa/Logging/LogSink.h>
#include <casacore/casa/Logging/LogFilter.h>
#include <casacore/tables/Tables/Table.h>
#include <casacore/tables/Tables/ScalarColumn.h>
#include <casacore/tables/Tables/ArrayColumn.h>
#include <casacore/casa/Utilities/Assert.h>
#include <casacore/casa/Exceptions/Error.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
class TableDesc;
class SetupNewTable;
// <summary>
// Save log messages in a Casacore Table
// </summary>
// <use visibility=export>
// <reviewed reviewer="wbrouw" date="1996/08/21" tests="tLogging.cc" demos="dLogging.cc">
// </reviewed>
// <prerequisite>
// <li> <linkto class=LogSinkInterface>LogSinkInterface</linkto>
// <li> <linkto module=Tables>Tables</linkto>
// </prerequisite>
//
// <etymology>
// Log to a Casacore Table.
// </etymology>
//
// <synopsis>
// Unlike the other classes derived from
// <linkto class=LogSinkInterface>LogSinkInterface</linkto>, there are utility
// functions in this class which might be of some modest interest. In
// particular, the member functions which define the structure of the table
// and define the column names might be of interest.
//
// This class posts messages which pass the filter to a Casacore
// <linkto class=Table>Table</linkto>. It puts every field of the
// <linkto class=LogMessage>LogMessage</linkto> into its own column.
// </synopsis>
//
// <example>
// See <linkto file="Logging.h">Logging.h</linkto>.
// </example>
//
// <motivation>
// "Persistent" log messages must be stored in a Table.
// </motivation>
//
// <todo asof="2001/06/12">
// <li> Allow a subset of the columns to be written? e.g., only time,
// message, and priority.
// <li> Allow time sorting in concatenate?
// </todo>
class TableLogSink : public LogSinkInterface
{
public:
// If <src>fileName</src> exists, attach and append to it, otherwise create
// a table with that name. If the table exists, it must have all the
// required columns defined by <src>logTableDescription()</src>.
// <group>
TableLogSink (LogMessage::Priority filter, const String& fileName);
TableLogSink (const LogFilterInterface& filter, const String& fileName);
// </group>
// Open the log table for readonly.
// If needed, reopenRW can be used later to define a filter and
// to open the logtable for writing.
explicit TableLogSink (const String& fileName);
// After copying, both sinks will write to the same <src>Table</src>.
// <group>
TableLogSink (const TableLogSink& other);
TableLogSink& operator= (const TableLogSink& other);
// </group>
~TableLogSink();
// Reopen the logtable for read/write (if needed).
// When it actually reopens, the given filter will be used.
void reopenRW (const LogFilterInterface& filter);
// If the message passes the filter, write it to the log table.
virtual Bool postLocally (const LogMessage& message);
// 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>
// Access to the actual log table and its columns.
// <note role=caution>
// Functions <src>time, priority, message, location, objectID</src>
// return a null <src>ScalarColumn</src> object when the logtable is
// not writable. Using it may result in using a null pointer
// causing a core dump. In debug mode it is checked if the object
// is not null.
// </note>
// <group>
const Table& table() const;
Table& table();
const ScalarColumn<Double>& roTime() const;
ScalarColumn<Double>& time();
const ScalarColumn<String>& roPriority() const;
ScalarColumn<String>& priority();
const ScalarColumn<String>& roMessage() const;
ScalarColumn<String>& message();
const ScalarColumn<String>& roLocation() const;
ScalarColumn<String>& location();
const ScalarColumn<String>& roObjectID() const;
ScalarColumn<String>& objectID();
// </group>
// Defines the minimal set of columns in the table (more may exist, but
// are ignored.
enum Columns {
// MJD in seconds, UT. (Double.)
TIME,
// Message importance. (String).
PRIORITY,
// Informational message. (String).
MESSAGE,
// Source code origin of the log message. Usually a combination of
// class name, method name, file name and line number, but any String
// is legal.
LOCATION,
// ObjectID of distributed object that created the message (String).
// If empty, no OBJECT_ID was set.
OBJECT_ID
};
// Turn the <src>Columns</src> enum into a String which is the actual
// column name in the <src>Table</src>.
static String columnName(Columns which);
// Description of the log table. You can use this if, e.g., you do not
// want to use the storage managers that this class creates by default
// (currently Miriad).
static TableDesc logTableDescription();
// Write out any pending output to the table.
virtual void flush (Bool global=True);
// Write a message (usually from another logsink) into the local one.
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).
virtual void clearLocally();
// Returns the id for this class...
static String localId( );
// Returns the id of the LogSink in use...
String id( ) const;
// Make a LogSink for a TableLogSink with a new table.
// Default filter is <src>NORMAL</src>.
// <group>
static LogSink makeSink (const String& fileName);
static LogSink makeSink (LogMessage::Priority filter,
const String& fileName);
static LogSink makeSink (const LogFilterInterface& filter,
const String& fileName);
// </group>
private:
// Undefined and inaccessible
TableLogSink();
// Avoid duplicating code in copy ctor and assignment operator
void copy_other(const TableLogSink& other);
// Make a new log table.
void makeTable (SetupNewTable&);
// Attach the column objects and create unit keywor if needed.
void attachCols();
// Initialize the object.
void init (const String& fileName);
Table log_table_p;
ScalarColumn<Double> time_p;
ScalarColumn<String> priority_p;
ScalarColumn<String> message_p;
// Origin
ScalarColumn<String> location_p;
// ObjectID
ScalarColumn<String> id_p;
};
//# Inlines
inline const Table& TableLogSink::table() const {return log_table_p;}
inline Table& TableLogSink::table() {return log_table_p;}
inline const ScalarColumn<Double>& TableLogSink::roTime() const
{return time_p;}
inline ScalarColumn<Double>& TableLogSink::time()
{return time_p;}
inline const ScalarColumn<String>& TableLogSink::roPriority() const
{return priority_p;}
inline ScalarColumn<String>& TableLogSink::priority()
{return priority_p;}
inline const ScalarColumn<String>& TableLogSink::roLocation() const
{return location_p;}
inline ScalarColumn<String>& TableLogSink::location()
{return location_p;}
inline const ScalarColumn<String>& TableLogSink::roObjectID() const
{return id_p;}
inline ScalarColumn<String>& TableLogSink::objectID()
{return id_p;}
inline const ScalarColumn<String>& TableLogSink::roMessage() const
{return message_p;}
inline ScalarColumn<String>& TableLogSink::message()
{return message_p;}
inline LogSink TableLogSink::makeSink (const String& fileName)
{ return makeSink (LogFilter(), fileName); }
inline LogSink TableLogSink::makeSink (LogMessage::Priority filter,
const String& fileName)
{ return makeSink (LogFilter(filter), fileName); }
} //# NAMESPACE CASACORE - END
#endif
|