casacore
MSProcessor.h
Go to the documentation of this file.
1//# MSProcessor.h: The MeasurementSet PROCESSOR Table
2//# Copyright (C) 1999,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_MSPROCESSOR_H
30#define MS_MSPROCESSOR_H
31
32#include <casacore/casa/aips.h>
33#include <casacore/ms/MeasurementSets/MSTable.h>
34#include <casacore/ms/MeasurementSets/MSProcessorEnums.h>
35
36namespace casacore { //# NAMESPACE CASACORE - BEGIN
37
38// <summary>
39// A Table intended to hold a MeasurementSet PROCESSOR table.
40// </summary>
41
42// <use visibility=export>
43
44// <reviewed reviewer="Bob Garwood" date="1997/02/01" tests="" demos="">
45
46// <prerequisite>
47// <li> <linkto class="MeasurementSet:description">MeasurementSet</linkto>
48// <li> <linkto class="MSTable">MSTable</linkto>
49// </prerequisite>
50//
51// <etymology>
52// MSProcessor stands for the MeasurementSet Processor table.
53// </etymology>
54//
55// <synopsis>
56// An MSProcessor is a table intended to hold the PROCESSOR table for
57// the MeasurementSet. It has an identical set of member functions as
58// the main MeasurementSet class. For further info and examples see the
59// MeasurementSet class.
60// </synopsis>
61//
62// <example>
63// See the MeasurementSet for an example of how to access and use this class.
64// </example>
65//
66// <motivation>
67// It was found that subtables and the main table of the MeasurementSet have
68// a lot in common, therefore they derive their interface from the same
69// base class. Each subtable has its own class to keep the enum definitions
70// and conversion functions in separate scopes.
71// </motivation>
72//
73// <todo asof="1999/01/15">
74// see MeasurementSet.
75// </todo>
76
78 public MSTable<MSProcessorEnums>
79{
80public:
81
82 // This constructs an empty MSProcessor.
84
85 // These constructors mirror the Table ones with additional checking
86 // on validity (verifying that the MSProcessor will have the required columns
87 // and keywords)
88 // An exception is thrown if the constructed Table is not a valid MSProcessor
89 // <thrown>
90 // <li> AipsError
91 // </thrown>
92 // <group name=tableLikeConstructors>
94 MSProcessor (const String &tableName, const String &tableDescName,
96 MSProcessor (SetupNewTable &newTab, rownr_t nrrow = 0,
97 Bool initialize = False);
98 MSProcessor (const Table &table);
99 MSProcessor (const MSProcessor &other);
100 // </group>
101
102 // As with tables, the destructor writes the table if necessary.
103 // Additional checking is done here to verify that all required
104 // columns are still present.
105 // If it is NOT valid, it will write the table and then throw an exception.
106 // <thrown>
107 // <li> AipsError
108 // </thrown>
110
111 // Assignment operator, reference semantics
113
114 // Make a special copy of this Table which references all columns from
115 // this Table except those mentioned; those are empty and writable.
116 // Each forwarded column has the same writable status as the underlying
117 // column. The mentioned columns all use the AipsIO storage manager.
118 // This function is inherited from MSTable and unlikely to be of use,
119 // except in the class MeasurementSet (see comment there)..
120 MSProcessor referenceCopy(const String& newTableName,
121 const Block<String>& writableColumns) const;
122
123 // Initialize the statics appropriately. This does not need to be
124 // called by users, it is called by the implementation class
125 // MSTableImpl.
127
128private:
129
130 // required by the need to throw an exception in the destructor
132};
133
134
135} //# NAMESPACE CASACORE - END
136
137#endif
138
139
140
141
142
simple 1-D array
Definition: Block.h:200
Enums for the MeasurementSet PROCESSER table.
MSProcessor(const MSProcessor &other)
Bool hasBeenDestroyed_p
required by the need to throw an exception in the destructor
Definition: MSProcessor.h:131
~MSProcessor()
As with tables, the destructor writes the table if necessary.
MSProcessor(SetupNewTable &newTab, rownr_t nrrow=0, Bool initialize=False)
MSProcessor()
This constructs an empty MSProcessor.
MSProcessor(const Table &table)
MSProcessor(const String &tableName, TableOption=Table::Old)
These constructors mirror the Table ones with additional checking on validity (verifying that the MSP...
MSProcessor referenceCopy(const String &newTableName, const Block< String > &writableColumns) const
Make a special copy of this Table which references all columns from this Table except those mentioned...
MSProcessor & operator=(const MSProcessor &)
Assignment operator, reference semantics.
static MSTableMaps initMaps()
Initialize the statics appropriately.
MSProcessor(const String &tableName, const String &tableDescName, TableOption=Table::Old)
A Table intended to hold astronomical data
Definition: MSTable.h:147
Create a new table - define shapes, data managers, etc.
Definition: SetupNewTab.h:341
String: the storage and methods of handling collections of characters.
Definition: String.h:225
const String & tableName() const
Get the table name.
Definition: Table.h:1187
TableOption
Define the possible options how a table can be opened.
Definition: Table.h:172
@ Old
existing table
Definition: Table.h:174
this file contains all the compiler specific defines
Definition: mainpage.dox:28
const Bool False
Definition: aipstype.h:44
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42
uInt64 rownr_t
Define the type of a row number in a table.
Definition: aipsxtype.h:46