casacore
MSStateEnums.h
Go to the documentation of this file.
1 //# MSStateEnums.h: Defs for the MS STATE table
2 //# Copyright (C) 1999,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_MSSTATEENUMS_H
30 #define MS_MSSTATEENUMS_H
31 
32 #include <casacore/casa/aips.h>
33 
34 namespace casacore { //# NAMESPACE CASACORE - BEGIN
35 
36 // <use visibility=export>
37 
38 // <summary> Enums for the MeasurementSet STATE table </summary>
39 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
40 // </reviewed>
41 // <etymology>
42 // This class contains the enums for the MeasurementSet STATE table
43 // </etymology>
44 // <synopsis>
45 // This class does nothing. It is merely a container for the enumerations
46 // used by the MSState class. These enumerations define the
47 // standard columns, keywords.
48 // </synopsis>
49 
50 // <example>
51 // See the documentation for MeasurementSet for examples on the use of these
52 // enumerations.
53 // </example>
54 // <todo asof="1999/01/22">
55 // All the todo items which may be related to this class are
56 // grouped with the todo items for MeasurementSet
57 // </todo>
58 //
59 
60 class MSStateEnums {
61 public:
62  // The STATE table colums with predefined meaning.
64  // "True" columns are defined.<BR>
65  // TYPE - UNIT - MEASURE
67  // Noise calibration temperature <BR>
68  // Double - K
69  CAL,
70  // Row flag <BR>
71  // Bool
73  // Load temperature <BR>
74  // Double - K.
76  // Observing mode, e.g. OFF_SPECTRUM <BR>
77  // String
79  // True for a reference phase <BR>
80  // Bool.
81  REF,
82  // True if the source signal is being observed <BR>
83  // Bool.
84  SIG,
85  // Sub scan number (>=0) relative to scan number in MAIN <BR>
86  // Int
88  // Number of required columns
90  // Not a column, but just a final enum specifying the number of enums.
92  };
93 
94  // Keywords with a predefined meaning
96  //
97  // "True" keywords are defined.
99  //
100  // Not a keyword, but just a final enum specifying the number of enums.
102  };
103 };
104 
105 } //# NAMESPACE CASACORE - END
106 
107 #endif
Enums for the MeasurementSet STATE table.
Definition: MSStateEnums.h:60
PredefinedKeywords
Keywords with a predefined meaning.
Definition: MSStateEnums.h:95
@ UNDEFINED_KEYWORD
"True" keywords are defined.
Definition: MSStateEnums.h:98
@ NUMBER_PREDEFINED_KEYWORDS
Not a keyword, but just a final enum specifying the number of enums.
Definition: MSStateEnums.h:101
PredefinedColumns
The STATE table colums with predefined meaning.
Definition: MSStateEnums.h:63
@ NUMBER_PREDEFINED_COLUMNS
Not a column, but just a final enum specifying the number of enums.
Definition: MSStateEnums.h:91
@ NUMBER_REQUIRED_COLUMNS
Number of required columns.
Definition: MSStateEnums.h:89
@ CAL
Noise calibration temperature Double - K.
Definition: MSStateEnums.h:69
@ REF
True for a reference phase Bool.
Definition: MSStateEnums.h:81
@ LOAD
Load temperature Double - K.
Definition: MSStateEnums.h:75
@ SIG
True if the source signal is being observed Bool.
Definition: MSStateEnums.h:84
@ UNDEFINED_COLUMN
"True" columns are defined.
Definition: MSStateEnums.h:66
@ OBS_MODE
Observing mode, e.g.
Definition: MSStateEnums.h:78
@ FLAG_ROW
Row flag Bool.
Definition: MSStateEnums.h:72
@ SUB_SCAN
Sub scan number (>=0) relative to scan number in MAIN Int.
Definition: MSStateEnums.h:87
this file contains all the compiler specific defines
Definition: mainpage.dox:28