casacore
SDHistoryHandler.h
Go to the documentation of this file.
1 //# SDHistoryFiller.h: fills the HISTORY table for the SDFITS filler
2 //# Copyright (C) 2000
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: aips2-request@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 //#
27 //# $Id$
28 
29 #ifndef MS_SDHISTORYHANDLER_H
30 #define MS_SDHISTORYHANDLER_H
31 
32 #include <casacore/casa/aips.h>
33 #include <casacore/casa/Arrays/ArrayFwd.h>
34 #include <casacore/casa/Containers/RecordField.h>
35 
36 namespace casacore { //# NAMESPACE CASACORE - BEGIN
37 
38 //# Forward Declarations
39 class MeasurementSet;
40 class MSHistory;
41 class MSHistoryColumns;
42 class Record;
43 
44 // <summary>
45 // </summary>
46 
47 // <use visibility=local> or <use visibility=export>
48 
49 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
50 // </reviewed>
51 
52 // <prerequisite>
53 // <li> SomeClass
54 // <li> SomeOtherClass
55 // <li> some concept
56 // </prerequisite>
57 //
58 // <etymology>
59 // </etymology>
60 //
61 // <synopsis>
62 // </synopsis>
63 //
64 // <example>
65 // </example>
66 //
67 // <motivation>
68 // </motivation>
69 //
70 // <templating arg=T>
71 // <li>
72 // <li>
73 // </templating>
74 //
75 // <thrown>
76 // <li>
77 // <li>
78 // </thrown>
79 //
80 // <todo asof="yyyy/mm/dd">
81 // <li> add this feature
82 // <li> fix this bug
83 // <li> start discussion of this possible extension
84 // </todo>
85 
87 {
88 public:
89  // default ctor is not attached to a MS and hence is useless until attached
91 
92  // attach this to a MS - no columns are explicitly handled here
93  SDHistoryHandler(MeasurementSet &ms, const Vector<Bool> &handledCols, const Record &row);
94 
95  // copy ctor
97 
99 
100  // assignment operator, uses copy semantics
102 
103  // attach to a MS
104  void attach(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
105 
106  // reset internals given indicated row, use the same MS
107  void resetRow(const Record &row);
108 
109  // fill - a new row is added on each call, the message time stamp is the current time
110  void fill(const Record& row, Int observationId,
111  const String &message, const String &priority);
112 private:
115 
116  // TIMESYS field pointer when available
118 
119  // cleanup everything
120  void clearAll();
121 
122  // clean up row-dependent stuff
123  void clearRow();
124 
125  // initialize everything
126  void initAll(MeasurementSet &ms, const Vector<Bool> &handledCols, const Record &row);
127 
128  // initialize stuff which depends on the row
129  void initRow(const Vector<Bool> &handledCols, const Record &row);
130 };
131 
132 
133 } //# NAMESPACE CASACORE - END
134 
135 #endif
Read-Only access to an individual field from a Record.
Definition: RecordField.h:229
void resetRow(const Record &row)
reset internals given indicated row, use the same MS
SDHistoryHandler & operator=(const SDHistoryHandler &other)
assignment operator, uses copy semantics
SDHistoryHandler()
default ctor is not attached to a MS and hence is useless until attached
void initRow(const Vector< Bool > &handledCols, const Record &row)
initialize stuff which depends on the row
void initAll(MeasurementSet &ms, const Vector< Bool > &handledCols, const Record &row)
initialize everything
SDHistoryHandler(const SDHistoryHandler &other)
copy ctor
void clearAll()
cleanup everything
void clearRow()
clean up row-dependent stuff
RORecordFieldPtr< String > timesys_p
TIMESYS field pointer when available.
SDHistoryHandler(MeasurementSet &ms, const Vector< Bool > &handledCols, const Record &row)
attach this to a MS - no columns are explicitly handled here
void attach(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach to a MS
MSHistoryColumns * msHisCols_p
void fill(const Record &row, Int observationId, const String &message, const String &priority)
fill - a new row is added on each call, the message time stamp is the current time
String: the storage and methods of handling collections of characters.
Definition: String.h:225
this file contains all the compiler specific defines
Definition: mainpage.dox:28
int Int
Definition: aipstype.h:50