MSDopplerIndex.h

Go to the documentation of this file.
00001 //# MSDopplerIndex: index into a MeasurementSet DOPPLER subtable
00002 //# Copyright (C) 2000,2002
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_MSDOPPLERINDEX_H
00030 #define MS_MSDOPPLERINDEX_H
00031 
00032 #include <casacore/casa/aips.h>
00033 #include <casacore/ms/MSSel/MSTableIndex.h>
00034 
00035 #include <casacore/casa/Containers/RecordField.h>
00036 
00037 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00038 
00039 //# forward declarations
00040 class MSDoppler;
00041 
00042 // <summary>
00043 // </summary>
00044 
00045 // <use visibility=export>
00046 
00047 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
00048 // </reviewed>
00049 
00050 // <prerequisite>
00051 //   <li> MeasurementSet
00052 //   <li> MSTableIndex
00053 // </prerequisite>
00054 //
00055 // <etymology>
00056 // </etymology>
00057 //
00058 // <synopsis>
00059 // </synopsis>
00060 //
00061 // <example>
00062 // </example>
00063 //
00064 // <motivation>
00065 // </motivation>
00066 //
00067 // <thrown>
00068 //    <li>
00069 //    <li>
00070 // </thrown>
00071 //
00072 
00073 class MSDopplerIndex : public MSTableIndex
00074 {
00075 public:
00076     // no index attached, use the attach function or assignment operator to change that
00077   MSDopplerIndex();
00078 
00079   // construct one using the indicated DOPPLER table
00080   MSDopplerIndex(const MSDoppler &doppler);
00081 
00082   // construct one from another
00083   MSDopplerIndex(const MSDopplerIndex &other);
00084 
00085   virtual ~MSDopplerIndex();
00086 
00087   MSDopplerIndex &operator=(const MSDopplerIndex &other);
00088 
00089   void attach(const MSDoppler &doppler);
00090 
00091   // access to the doppler ID key, throws an exception if isNull() is False
00092   Int &dopplerId() {return *dopplerId_p;}
00093 
00094   // access to the source ID key, throws an exception if isNull() is False
00095   Int &sourceId() {return *sourceId_p;}
00096 private:
00097   RecordFieldPtr<Int> dopplerId_p, sourceId_p;
00098 
00099   void attachIds();
00100 };
00101 
00102 
00103 } //# NAMESPACE CASACORE - END
00104 
00105 #endif
00106     
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1