casacore
SDSourceHandler.h
Go to the documentation of this file.
1 //# SDSourceFiller.h: fills the SOURCE 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_SDSOURCEHANDLER_H
30 #define MS_SDSOURCEHANDLER_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 ColumnsIndex;
40 class MeasurementSet;
41 class MSSource;
42 class MSSourceColumns;
43 class Record;
44 
45 // <summary>
46 // </summary>
47 
48 // <use visibility=local> or <use visibility=export>
49 
50 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
51 // </reviewed>
52 
53 // <prerequisite>
54 // <li> SomeClass
55 // <li> SomeOtherClass
56 // <li> some concept
57 // </prerequisite>
58 //
59 // <etymology>
60 // </etymology>
61 //
62 // <synopsis>
63 // </synopsis>
64 //
65 // <example>
66 // </example>
67 //
68 // <motivation>
69 // </motivation>
70 //
71 // <templating arg=T>
72 // <li>
73 // <li>
74 // </templating>
75 //
76 // <thrown>
77 // <li>
78 // <li>
79 // </thrown>
80 //
81 // <todo asof="yyyy/mm/dd">
82 // <li> add this feature
83 // <li> fix this bug
84 // <li> start discussion of this possible extension
85 // </todo>
86 
88 {
89 public:
90  // default ctor is not attached to a MS and hence is useless until attached
92 
93  // attach this to a MS, marking fields in row which are explicitly handled here
94  SDSourceHandler(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
95 
96  // copy ctor
98 
100 
101  // assignment operator, uses copy semantics
103 
104  // attach to a MS, the handledCols and row arguments are ignored here
105  void attach(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
106 
107  // reset internals given indicated row, use the same MS; just resets the id pointer
108  void resetRow(const Record &);
109 
110  // fill - a source is unique in source name and code
111  void fill(const Record &row, Int spectralWindowId);
112 
113  // get the current source ID
114  Int sourceId() {return sourceId_p;}
115 private:
120 
121  // the current source ID
123 
124  // the next source ID to use
126 
127  // fields possibly mined from the SDFITS row
128  // floating point fields that we can't be certain of their type
130  // String fields
132 
133  // which optional colums exist
135 
136  // fields which might come from a pre-existin MS
140 
141  // cleanup everything
142  void clearAll();
143 
144  // clean up items related to the row
145  void clearRow();
146 
147  // initialize everything
148  void initAll(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
149 
150  // initialize the stuff dependent on the row
151  void initRow(Vector<Bool> &handledCols, const Record &row);
152 };
153 
154 
155 } //# NAMESPACE CASACORE - END
156 
157 #endif
158 
159 
Read-Only access to an individual field from a Record.
Definition: RecordField.h:229
SDSourceHandler(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach this to a MS, marking fields in row which are explicitly handled here
Int sourceId_p
the current source ID
Int nextSourceId_p
the next source ID to use
void fill(const Record &row, Int spectralWindowId)
fill - a source is unique in source name and code
void attach(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
attach to a MS, the handledCols and row arguments are ignored here
RecordFieldPtr< String > codeKey_p
RORecordFieldPtr< Array< Double > > properMotionField_p
void initAll(MeasurementSet &ms, Vector< Bool > &handledCols, const Record &row)
initialize everything
Int sourceId()
get the current source ID
SDSourceHandler()
default ctor is not attached to a MS and hence is useless until attached
RORecordFieldPtr< String > object_p
RORecordFieldPtr< String > obsmode_p
void clearAll()
cleanup everything
RORecordFieldPtr< String > molecule_p
RecordFieldPtr< String > nameKey_p
RORecordFieldPtr< Int > calibrationGroupField_p
fields which might come from a pre-existin MS
MSSourceColumns * msSourceCols_p
RORecordFieldPtr< Array< Double > > directionField_p
RORecordFieldPtr< Array< Double > > positionField_p
RORecordFieldPtr< String > transiti_p
String fields.
void clearRow()
clean up items related to the row
RORecordFieldPtr< Double > intervalField_p
void resetRow(const Record &)
reset internals given indicated row, use the same MS; just resets the id pointer
void initRow(Vector< Bool > &handledCols, const Record &row)
initialize the stuff dependent on the row
RORecordFieldPtr< Double > timeField_p
SDSourceHandler(const SDSourceHandler &other)
copy ctor
SDSourceHandler & operator=(const SDSourceHandler &other)
assignment operator, uses copy semantics
RORecordFieldPtr< Int > pulsarIdField_p
Int restfreq_p
fields possibly mined from the SDFITS row floating point fields that we can't be certain of their typ...
Bool hasTransition_p
which optional colums exist
this file contains all the compiler specific defines
Definition: mainpage.dox:28
int Int
Definition: aipstype.h:50
bool Bool
Define the standard types used by Casacore.
Definition: aipstype.h:42