SDSourceHandler.h

Go to the documentation of this file.
00001 //# SDSourceFiller.h: fills the SOURCE table for the SDFITS filler
00002 //# Copyright (C) 2000
00003 //# Associated Universities, Inc. Washington DC, USA.
00004 //#
00005 //# This library is free software; you can redistribute it and/or modify it
00006 //# under the terms of the GNU Library General Public License as published by
00007 //# the Free Software Foundation; either version 2 of the License, or (at your
00008 //# option) any later version.
00009 //#
00010 //# This library is distributed in the hope that it will be useful, but WITHOUT
00011 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
00012 //# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
00013 //# License for more details.
00014 //#
00015 //# You should have received a copy of the GNU Library General Public License
00016 //# along with this library; if not, write to the Free Software Foundation,
00017 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
00018 //#
00019 //# Correspondence concerning AIPS++ should be addressed as follows:
00020 //#        Internet email: aips2-request@nrao.edu.
00021 //#        Postal address: AIPS++ Project Office
00022 //#                        National Radio Astronomy Observatory
00023 //#                        520 Edgemont Road
00024 //#                        Charlottesville, VA 22903-2475 USA
00025 //#
00026 //#
00027 //# $Id$
00028 
00029 #ifndef MS_SDSOURCEHANDLER_H
00030 #define MS_SDSOURCEHANDLER_H
00031 
00032 #include <casacore/casa/aips.h>
00033 #include <casacore/casa/Containers/RecordField.h>
00034 
00035 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00036 
00037 //# Forward Declarations
00038 class ColumnsIndex;
00039 class MeasurementSet;
00040 class MSSource;
00041 class MSSourceColumns;
00042 class Record;
00043 
00044 template <class T> class Vector;
00045 
00046 // <summary>
00047 // </summary>
00048 
00049 // <use visibility=local>   or   <use visibility=export>
00050 
00051 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
00052 // </reviewed>
00053 
00054 // <prerequisite>
00055 //   <li> SomeClass
00056 //   <li> SomeOtherClass
00057 //   <li> some concept
00058 // </prerequisite>
00059 //
00060 // <etymology>
00061 // </etymology>
00062 //
00063 // <synopsis>
00064 // </synopsis>
00065 //
00066 // <example>
00067 // </example>
00068 //
00069 // <motivation>
00070 // </motivation>
00071 //
00072 // <templating arg=T>
00073 //    <li>
00074 //    <li>
00075 // </templating>
00076 //
00077 // <thrown>
00078 //    <li>
00079 //    <li>
00080 // </thrown>
00081 //
00082 // <todo asof="yyyy/mm/dd">
00083 //   <li> add this feature
00084 //   <li> fix this bug
00085 //   <li> start discussion of this possible extension
00086 // </todo>
00087 
00088 class SDSourceHandler
00089 {
00090 public:
00091     // default ctor is not attached to a MS and hence is useless until attached
00092     SDSourceHandler();
00093 
00094     // attach this to a MS, marking fields in row which are explicitly handled here
00095     SDSourceHandler(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
00096 
00097     // copy ctor
00098     SDSourceHandler(const SDSourceHandler &other);
00099 
00100     ~SDSourceHandler() {clearAll();}
00101 
00102     // assignment operator, uses copy semantics
00103     SDSourceHandler &operator=(const SDSourceHandler &other);
00104 
00105     // attach to a MS, the handledCols and row arguments are ignored here
00106     void attach(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
00107 
00108     // reset internals given indicated row, use the same MS; just resets the id pointer
00109     void resetRow(const Record &);
00110     
00111     // fill - a source is unique in source name and code
00112     void fill(const Record &row, Int spectralWindowId);
00113 
00114     // get the current source ID
00115     Int sourceId() {return sourceId_p;}
00116 private:
00117     RecordFieldPtr<String> nameKey_p, codeKey_p;
00118     ColumnsIndex *index_p;
00119     MSSource *msSource_p;
00120     MSSourceColumns *msSourceCols_p;
00121 
00122     // the current source ID
00123     Int sourceId_p;
00124 
00125     // the next source ID to use
00126     Int nextSourceId_p;
00127 
00128     // fields possibly mined from the SDFITS row
00129     // floating point fields that we can't be certain of their type
00130     Int restfreq_p, vframe_p;
00131     // String fields
00132     RORecordFieldPtr<String> transiti_p, molecule_p, object_p, obsmode_p;
00133 
00134     // which optional colums exist
00135     Bool hasTransition_p, hasRestFreq_p, hasSysVel_p, hasPosition_p;
00136 
00137     // fields which might come from a pre-existin MS
00138     RORecordFieldPtr<Int> calibrationGroupField_p, pulsarIdField_p;
00139     RORecordFieldPtr<Double> timeField_p, intervalField_p;
00140     RORecordFieldPtr<Array<Double> > directionField_p, positionField_p, properMotionField_p;
00141 
00142     // cleanup everything
00143     void clearAll();
00144 
00145     // clean up items related to the row
00146     void clearRow();
00147 
00148     // initialize everything
00149     void initAll(MeasurementSet &ms, Vector<Bool> &handledCols, const Record &row);
00150 
00151     // initialize the stuff dependent on the row
00152     void initRow(Vector<Bool> &handledCols, const Record &row);
00153 };
00154 
00155 
00156 } //# NAMESPACE CASACORE - END
00157 
00158 #endif
00159 
00160 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1