casacore
MSDopplerIndex.h
Go to the documentation of this file.
1 //# MSDopplerIndex: index into a MeasurementSet DOPPLER subtable
2 //# Copyright (C) 2000,2002
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_MSDOPPLERINDEX_H
30 #define MS_MSDOPPLERINDEX_H
31 
32 #include <casacore/casa/aips.h>
33 #include <casacore/ms/MSSel/MSTableIndex.h>
34 
35 #include <casacore/casa/Containers/RecordField.h>
36 
37 namespace casacore { //# NAMESPACE CASACORE - BEGIN
38 
39 //# forward declarations
40 class MSDoppler;
41 
42 // <summary>
43 // </summary>
44 
45 // <use visibility=export>
46 
47 // <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
48 // </reviewed>
49 
50 // <prerequisite>
51 // <li> MeasurementSet
52 // <li> MSTableIndex
53 // </prerequisite>
54 //
55 // <etymology>
56 // </etymology>
57 //
58 // <synopsis>
59 // </synopsis>
60 //
61 // <example>
62 // </example>
63 //
64 // <motivation>
65 // </motivation>
66 //
67 // <thrown>
68 // <li>
69 // <li>
70 // </thrown>
71 //
72 
74 {
75 public:
76  // no index attached, use the attach function or assignment operator to change that
78 
79  // construct one using the indicated DOPPLER table
80  MSDopplerIndex(const MSDoppler &doppler);
81 
82  // construct one from another
84 
85  virtual ~MSDopplerIndex();
86 
88 
89  void attach(const MSDoppler &doppler);
90 
91  // access to the doppler ID key, throws an exception if isNull() is False
92  Int &dopplerId() {return *dopplerId_p;}
93 
94  // access to the source ID key, throws an exception if isNull() is False
95  Int &sourceId() {return *sourceId_p;}
96 private:
98 
99  void attachIds();
100 };
101 
102 
103 } //# NAMESPACE CASACORE - END
104 
105 #endif
106 
Int & sourceId()
access to the source ID key, throws an exception if isNull() is False
Int & dopplerId()
access to the doppler ID key, throws an exception if isNull() is False
void attach(const MSDoppler &doppler)
RecordFieldPtr< Int > sourceId_p
MSDopplerIndex & operator=(const MSDopplerIndex &other)
MSDopplerIndex()
no index attached, use the attach function or assignment operator to change that
MSDopplerIndex(const MSDopplerIndex &other)
construct one from another
RecordFieldPtr< Int > dopplerId_p
MSDopplerIndex(const MSDoppler &doppler)
construct one using the indicated DOPPLER table
this file contains all the compiler specific defines
Definition: mainpage.dox:28
int Int
Definition: aipstype.h:50