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