casacore
SDAntennaHandler.h
Go to the documentation of this file.
1 //# SDAntennaFiller.h: fills the ANTENNA 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_SDANTENNAHANDLER_H
30 #define MS_SDANTENNAHANDLER_H
31 
32 #include <casacore/casa/aips.h>
33 #include <casacore/casa/Containers/RecordField.h>
34 #include <casacore/casa/BasicSL/String.h>
35 #include <casacore/measures/Measures/MPosition.h>
36 #include <casacore/casa/Arrays/Array.h>
37 
38 namespace casacore { //# NAMESPACE CASACORE - BEGIN
39 
40 //# Forward Declarations
41 class ColumnsIndex;
42 class MeasurementSet;
43 class MSAntenna;
44 class MSAntennaColumns;
45 class Record;
46 
47 template <class T> class Vector;
48 
49 // <summary>
50 // </summary>
51 
52 // <use visibility=local> or <use visibility=export>
53 
54 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
55 // </reviewed>
56 
57 // <prerequisite>
58 // <li> SomeClass
59 // <li> SomeOtherClass
60 // <li> some concept
61 // </prerequisite>
62 //
63 // <etymology>
64 // </etymology>
65 //
66 // <synopsis>
67 // </synopsis>
68 //
69 // <example>
70 // </example>
71 //
72 // <motivation>
73 // </motivation>
74 //
75 // <templating arg=T>
76 // <li>
77 // <li>
78 // </templating>
79 //
80 // <thrown>
81 // <li>
82 // <li>
83 // </thrown>
84 //
85 // <todo asof="yyyy/mm/dd">
86 // <li> add this feature
87 // <li> fix this bug
88 // <li> start discussion of this possible extension
89 // </todo>
90 
92 {
93 public:
94  // default ctor is not attached to a MS and hence is useless until attached
96 
97  // attach this to a MS, mark the appropriate columns as handled given
98  // the indicated row
99  SDAntennaHandler(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
100 
101  // copy ctor
103 
105 
106  // assignment operator, uses copy semantics
108 
109  // attach to a MS, mark the appropriate columns as handled given the
110  void attach(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
111 
112  // reset internals given indicated row, use the same MS
113  void resetRow(const Record &row);
114 
115  // fill - a new row is added only when necessary
116  void fill(const Record &row);
117 
118  // get the current antenna ID
119  Int antennaId() {return rownr_p;}
120 
121  // get the telescope name
123 
124  // get the telescope position
126 private:
134 
136 
137  // pointers to fields in record, only used if attached
139 
140  // telescope position might be a double or float,
141  // just remember its location
143 
146 
147  // fields which might exist if this SDFITS was converted from an MS using ms2sdfits
153 
154  // I expect these will never be used, nevertheless, put them here just in case I'm wrong
157 
158  // cleanup everything
159  void clearAll();
160 
161  // cleanup things which depend on the row description being fixed
162  void clearRow();
163 
164  // initialize everything
165  void initAll(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
166 
167  // initialize the things which depend on the row
168  void initRow(Vector<Bool> &handledCols, const Record &row);
169 };
170 
171 
172 } //# NAMESPACE CASACORE - END
173 
174 #endif
175 
176 
casacore::RecordFieldPtr
Access to an individual field in a record.
Definition: RecordField.h:119
casacore::SDAntennaHandler::initRow
void initRow(Vector< Bool > &handledCols, const Record &row)
initialize the things which depend on the row
casacore::SDAntennaHandler::msAnt_p
MSAntenna * msAnt_p
Definition: SDAntennaHandler.h:132
casacore::SDAntennaHandler::name_p
String name_p
Definition: SDAntennaHandler.h:144
casacore::SDAntennaHandler::telescopeName
String telescopeName()
get the telescope name
Definition: SDAntennaHandler.h:122
casacore::MPosition
A Measure: position on Earth.
Definition: MPosition.h:79
casacore::SDAntennaHandler::position_p
MPosition position_p
Definition: SDAntennaHandler.h:145
casacore::SDAntennaHandler::siteElevFldNum_p
Int siteElevFldNum_p
Definition: SDAntennaHandler.h:142
casacore::SDAntennaHandler::addPhasedArrayIdColumn
void addPhasedArrayIdColumn()
I expect these will never be used, nevertheless, put them here just in case I'm wrong.
casacore::SDAntennaHandler::siteLatFldNum_p
Int siteLatFldNum_p
Definition: SDAntennaHandler.h:142
casacore::SDAntennaHandler::flagRowField_p
RORecordFieldPtr< Bool > flagRowField_p
Definition: SDAntennaHandler.h:152
casacore::SDAntennaHandler::offsetField_p
RORecordFieldPtr< Array< Double > > offsetField_p
Definition: SDAntennaHandler.h:151
casacore::SDAntennaHandler::clearAll
void clearAll()
cleanup everything
casacore::SDAntennaHandler::positionField_p
RORecordFieldPtr< Array< Double > > positionField_p
Definition: SDAntennaHandler.h:151
casacore::SDAntennaHandler::SDAntennaHandler
SDAntennaHandler(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach this to a MS, mark the appropriate columns as handled given the indicated row
casacore::ColumnsIndex
Index to one or more columns in a table.
Definition: ColumnsIndex.h:228
casacore::SDAntennaHandler::msNameField_p
RORecordFieldPtr< String > msNameField_p
Definition: SDAntennaHandler.h:148
casacore::SDAntennaHandler::SDAntennaHandler
SDAntennaHandler()
default ctor is not attached to a MS and hence is useless until attached
casacore::SDAntennaHandler::operator=
SDAntennaHandler & operator=(const SDAntennaHandler &other)
assignment operator, uses copy semantics
casacore::SDAntennaHandler::attach
void attach(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach to a MS, mark the appropriate columns as handled given the
casacore::SDAntennaHandler::initAll
void initAll(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
initialize everything
casacore::SDAntennaHandler::dishDiameterField_p
RORecordFieldPtr< Double > dishDiameterField_p
Definition: SDAntennaHandler.h:150
casacore::MSAntenna
A Table intended to hold a MeasurementSet ANTENNA table.
Definition: MSAntenna.h:81
casacore::SDAntennaHandler::telescopField_p
RORecordFieldPtr< String > telescopField_p
pointers to fields in record, only used if attached
Definition: SDAntennaHandler.h:138
casacore::SDAntennaHandler::nameKey_p
RecordFieldPtr< String > nameKey_p
Definition: SDAntennaHandler.h:128
casacore::SDAntennaHandler::fill
void fill(const Record &row)
fill - a new row is added only when necessary
casacore::Int
int Int
Definition: aipstype.h:50
casacore
this file contains all the compiler specific defines
Definition: mainpage.dox:28
casacore::SDAntennaHandler::phasedIdKey_p
RecordFieldPtr< Int > phasedIdKey_p
Definition: SDAntennaHandler.h:130
casacore::SDAntennaHandler::flagRowKey_p
RecordFieldPtr< Bool > flagRowKey_p
Definition: SDAntennaHandler.h:131
casacore::SDAntennaHandler::~SDAntennaHandler
~SDAntennaHandler()
Definition: SDAntennaHandler.h:104
casacore::SDAntennaHandler
Definition: SDAntennaHandler.h:92
casacore::SDAntennaHandler::stationKey_p
RecordFieldPtr< String > stationKey_p
Definition: SDAntennaHandler.h:128
casacore::SDAntennaHandler::SDAntennaHandler
SDAntennaHandler(const SDAntennaHandler &other)
copy ctor
casacore::SDAntennaHandler::phasedArrayIdField_p
RORecordFieldPtr< Int > phasedArrayIdField_p
Definition: SDAntennaHandler.h:149
casacore::SDAntennaHandler::antennaId
Int antennaId()
get the current antenna ID
Definition: SDAntennaHandler.h:119
casacore::SDAntennaHandler::mountKey_p
RecordFieldPtr< String > mountKey_p
Definition: SDAntennaHandler.h:128
casacore::SDAntennaHandler::dishDiameterKey_p
RecordFieldPtr< Double > dishDiameterKey_p
Definition: SDAntennaHandler.h:129
casacore::SDAntennaHandler::clearRow
void clearRow()
cleanup things which depend on the row description being fixed
casacore::MeasurementSet
A Table intended to hold astronomical data (a set of Measurements).
Definition: MeasurementSet.h:243
casacore::RORecordFieldPtr
Read-Only access to an individual field from a Record.
Definition: RecordField.h:229
casacore::MSAntennaColumns
A class to provide easy access to MSAntenna columns.
Definition: MSAntennaColumns.h:80
casacore::String
String: the storage and methods of handling collections of characters.
Definition: String.h:223
casacore::SDAntennaHandler::stationField_p
RORecordFieldPtr< String > stationField_p
Definition: SDAntennaHandler.h:148
casacore::SDAntennaHandler::orbitIdField_p
RORecordFieldPtr< Int > orbitIdField_p
Definition: SDAntennaHandler.h:149
casacore::SDAntennaHandler::resetRow
void resetRow(const Record &row)
reset internals given indicated row, use the same MS
casacore::Record
A hierarchical collection of named fields of various types.
Definition: Record.h:181
casacore::SDAntennaHandler::siteLongFldNum_p
Int siteLongFldNum_p
telescope position might be a double or float, just remember its location
Definition: SDAntennaHandler.h:142
casacore::SDAntennaHandler::msAntCols_p
MSAntennaColumns * msAntCols_p
Definition: SDAntennaHandler.h:133
casacore::Vector< Bool >
casacore::SDAntennaHandler::rownr_p
Int rownr_p
Definition: SDAntennaHandler.h:135
casacore::SDAntennaHandler::index_p
ColumnsIndex * index_p
Definition: SDAntennaHandler.h:127
casacore::SDAntennaHandler::mountField_p
RORecordFieldPtr< String > mountField_p
fields which might exist if this SDFITS was converted from an MS using ms2sdfits
Definition: SDAntennaHandler.h:148
casacore::SDAntennaHandler::addOrbitIdColumn
void addOrbitIdColumn()
casacore::SDAntennaHandler::orbitIdKey_p
RecordFieldPtr< Int > orbitIdKey_p
Definition: SDAntennaHandler.h:130
casacore::SDAntennaHandler::telescopePosition
const MPosition & telescopePosition()
get the telescope position
Definition: SDAntennaHandler.h:125