/usr/include/casacore/ms/MeasurementSets/MSHistoryColumns.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 | //# MSHistoryColumns.h: provides easy access to MSHistory columns
//# Copyright (C) 1996,1999,2000
//# 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 MS_MSHISTORYCOLUMNS_H
#define MS_MSHISTORYCOLUMNS_H
#include <casacore/casa/aips.h>
#include <casacore/measures/Measures/MEpoch.h>
#include <casacore/measures/Measures/MCEpoch.h>
#include <casacore/tables/Tables/ScalarColumn.h>
#include <casacore/tables/Tables/ArrayColumn.h>
#include <casacore/measures/TableMeasures/ScalarMeasColumn.h>
#include <casacore/measures/TableMeasures/ScalarQuantColumn.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
class MSHistory;
// <summary>
// A class to provide easy read-only access to MSHistory columns
// </summary>
// <use visibility=export>
// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MSHistory
// <li> ArrayColumn
// <li> ScalarColumn
// </prerequisite>
//
// <etymology>
// ROMSHistoryColumns stands for Read-Only MeasurementSet History Table columns.
// </etymology>
//
// <synopsis>
// This class provides read-only access to the columns in the MSHistory
// Table. It does the declaration of all the Scalar and ArrayColumns with the
// correct types, so the application programmer doesn't have to worry about
// getting those right. There is an access function for every predefined
// column. Access to non-predefined columns will still have to be done with
// explicit declarations. See <linkto class=ROMSColumns>
// ROMSColumns</linkto> for an example.
// </synopsis>
//
// <motivation>
// See <linkto class=MSColumns> MSColumns</linkto> for the motivation.
// </motivation>
class ROMSHistoryColumns
{
public:
// Create a columns object that accesses the data in the specified Table
ROMSHistoryColumns(const MSHistory& msHistory);
// The destructor does nothing special
~ROMSHistoryColumns();
// Access to required columns
// <group>
const ROScalarColumn<String>& application() const {return application_p;}
const ROArrayColumn<String>& appParams() const {return appParams_p;}
const ROArrayColumn<String>& cliCommand() const {return cliCommand_p;}
const ROScalarColumn<String>& message() const {return message_p;}
const ROScalarColumn<Int>& objectId() const {return objectId_p;}
const ROScalarColumn<Int>& observationId() const {return observationId_p;}
const ROScalarColumn<String>& origin() const {return origin_p;}
const ROScalarColumn<String>& priority() const {return priority_p;}
const ROScalarColumn<Double>& time() const {return time_p;}
const ROScalarQuantColumn<Double>& timeQuant() const {return timeQuant_p;}
const ROScalarMeasColumn<MEpoch>& timeMeas() const {return timeMeas_p;}
// </group>
// Convenience function that returns the number of rows in any of the columns
uInt nrow() const {return application_p.nrow();}
protected:
//# default constructor creates a object that is not usable. Use the attach
//# function correct this.
ROMSHistoryColumns();
//# attach this object to the supplied table.
void attach(const MSHistory& msHistory);
private:
//# Make the assignment operator and the copy constructor private to prevent
//# any compiler generated one from being used.
ROMSHistoryColumns(const ROMSHistoryColumns&);
ROMSHistoryColumns& operator=(const ROMSHistoryColumns&);
//# required columns
ROScalarColumn<String> application_p;
ROArrayColumn<String> appParams_p;
ROArrayColumn<String> cliCommand_p;
ROScalarColumn<String> message_p;
ROScalarColumn<Int> objectId_p;
ROScalarColumn<Int> observationId_p;
ROScalarColumn<String> origin_p;
ROScalarColumn<String> priority_p;
ROScalarColumn<Double> time_p;
//# Access to Measure columns
ROScalarMeasColumn<MEpoch> timeMeas_p;
//# Access to Quantum columns
ROScalarQuantColumn<Double> timeQuant_p;
};
// <summary>
// A class to provide easy read-write access to MSHistory columns
// </summary>
// <use visibility=export>
// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MSHistory
// <li> ArrayColumn
// <li> ScalarColumn
// </prerequisite>
//
// <etymology>
// MSHistoryColumns stands for MeasurementSet History Table columns.
// </etymology>
//
// <synopsis>
// This class provides access to the columns in the MSHistory Table,
// it does the declaration of all the Scalar and ArrayColumns with the
// correct types, so the application programmer doesn't have to
// worry about getting those right. There is an access function
// for every predefined column. Access to non-predefined columns will still
// have to be done with explicit declarations.
// See <linkto class=MSColumns> MSColumns</linkto> for an example.
//
// Note by GvD 28-Jan-2010:
// According to note 229 the OBJECTID column should contain Strings.
// It is, however, defined as Int. It has to be left as such, otherwise older
// MeasurementSets cannot be read anymore.
// </synopsis>
//
// <motivation>
// See <linkto class=MSColumns> MSColumns</linkto> for the motivation.
// </motivation>
class MSHistoryColumns: public ROMSHistoryColumns
{
public:
// Create a columns object that accesses the data in the specified Table
MSHistoryColumns(MSHistory& msHistory);
// The destructor does nothing special
~MSHistoryColumns();
// Read-write access to required columns
// <group>
ScalarColumn<String>& application() {return application_p;}
ArrayColumn<String>& appParams() {return appParams_p;}
ArrayColumn<String>& cliCommand() {return cliCommand_p;}
ScalarColumn<String>& message() {return message_p;}
ScalarColumn<Int>& objectId() {return objectId_p;}
ScalarColumn<Int>& observationId() {return observationId_p;}
ScalarColumn<String>& origin() {return origin_p;}
ScalarColumn<String>& priority() {return priority_p;}
ScalarColumn<Double>& time() {return time_p;}
ScalarQuantColumn<Double>& timeQuant() {return timeQuant_p;}
ScalarMeasColumn<MEpoch>& timeMeas() {return timeMeas_p;}
// </group>
// Read-only access to required columns
// <group>
const ROScalarColumn<String>& application() const {
return ROMSHistoryColumns::application();}
const ROArrayColumn<String>& appParams() const {
return ROMSHistoryColumns::appParams();}
const ROArrayColumn<String>& cliCommand() const {
return ROMSHistoryColumns::cliCommand();}
const ROScalarColumn<String>& message() const {
return ROMSHistoryColumns::message();}
const ROScalarColumn<Int>& objectId() const {
return ROMSHistoryColumns::objectId();}
const ROScalarColumn<Int>& observationId() const {
return ROMSHistoryColumns::observationId();}
const ROScalarColumn<String>& origin() const {
return ROMSHistoryColumns::origin();}
const ROScalarColumn<String>& priority() const {
return ROMSHistoryColumns::priority();}
const ROScalarColumn<Double>& time() const {
return ROMSHistoryColumns::time();}
const ROScalarQuantColumn<Double>& timeQuant() const {
return ROMSHistoryColumns::timeQuant();}
const ROScalarMeasColumn<MEpoch>& timeMeas() const {
return ROMSHistoryColumns::timeMeas();}
// </group>
// set the epoch type for the TIME column.
// <note role=tip>
// In principle this function can only be used if the table is empty,
// otherwise already written values may thereafter have an incorrect
// reference, offset, or unit. However, it is possible that part of the
// table gets written before these values are known. In that case the
// reference, offset, or units can be set by using a False
// <src>tableMustBeEmpty</src> argument.
// </note>
void setEpochRef(MEpoch::Types ref, Bool tableMustBeEmpty=True);
protected:
//# default constructor creates a object that is not usable. Use the attach
//# function correct this.
MSHistoryColumns();
//# attach this object to the supplied table.
void attach(MSHistory& msHistory);
private:
//# Make the assignment operator and the copy constructor private to prevent
//# any compiler generated one from being used.
MSHistoryColumns(const MSHistoryColumns&);
MSHistoryColumns& operator=(const MSHistoryColumns&);
//# required columns
ScalarColumn<String> application_p;
ArrayColumn<String> appParams_p;
ArrayColumn<String> cliCommand_p;
ScalarColumn<String> message_p;
ScalarColumn<Int> objectId_p;
ScalarColumn<Int> observationId_p;
ScalarColumn<String> origin_p;
ScalarColumn<String> priority_p;
ScalarColumn<Double> time_p;
//# Access to Measure columns
ScalarMeasColumn<MEpoch> timeMeas_p;
//# Access to Quantum columns
ScalarQuantColumn<Double> timeQuant_p;
};
} //# NAMESPACE CASACORE - END
#endif
|