casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
MSObsEnums.h
Go to the documentation of this file.
00001 //# MSObservationEnums.h: Definitions for the MeasurementSet OBSERVATION table
00002 //# Copyright (C) 1996,1999,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: MSObsEnums.h 18093 2004-11-30 17:51:10Z ddebonis $
00028 
00029 #ifndef MS_MSOBSENUMS_H
00030 #define MS_MSOBSENUMS_H
00031 
00032 namespace casa { //# NAMESPACE CASA - BEGIN
00033 
00034 // <use visibility=export>
00035 
00036 // <summary> Enums for the MeasurementSet OBSERVATION table </summary>
00037 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
00038 // </reviewed>
00039 // <etymology>
00040 // This class contains the enums for the MeasurementSet OBSERVATION table
00041 // </etymology>
00042 // <synopsis>
00043 // This class does nothing.  It is merely a container for the enumerations
00044 // used by the MSObservation class.  These enumerations define the
00045 // standard columns, keywords.
00046 // </synopsis>
00047 
00048 // <example>
00049 // See the documentation for MeasurementSet for examples on the use of these
00050 // enumerations.
00051 // </example>
00052 // <todo asof="1999/01/14">
00053 // All the todo items which may be related to this class are
00054 // grouped with the todo items for MeasurementSet
00055 // </todo>
00056 //
00057 
00058 class MSObservationEnums {
00059 public:
00060     // The OBSERVATION table colums with predefined meaning.
00061     // The OBSERVATION_ID is the row number .
00062     enum PredefinedColumns {
00063     // "True" columns are defined.<BR>
00064     // TYPE - UNIT - MEASURE
00065     UNDEFINED_COLUMN=0,
00066     // Row flag <BR>
00067     // Bool
00068     FLAG_ROW,
00069     // Observing log <BR>
00070     // String(*)
00071     LOG,
00072     // Name of observer(s) <BR>
00073     // String
00074     OBSERVER,
00075     // Project identification string<BR>
00076     // TpString
00077     PROJECT,
00078     // Release data, date when data may become public <BR>
00079     // Double - s - EPOCH
00080     RELEASE_DATE,
00081     // Observing schedule <BR>
00082     // String(*)
00083     SCHEDULE,
00084     // Observing schedule type <BR>
00085     // String
00086     SCHEDULE_TYPE,
00087     // Telescope name <BR>
00088     // TpString
00089     TELESCOPE_NAME,
00090     // Start and end times of observation <BR>
00091     // Double(2)
00092     TIME_RANGE,
00093     // Number of required columns
00094     NUMBER_REQUIRED_COLUMNS=TIME_RANGE,
00095     // Not a column, but just a final enum specifying the number of enums.
00096     NUMBER_PREDEFINED_COLUMNS=NUMBER_REQUIRED_COLUMNS
00097     };
00098   
00099     // Keywords with a predefined meaning
00100     enum PredefinedKeywords {
00101     //
00102     // "True" keywords are defined. 
00103     UNDEFINED_KEYWORD=0,
00104     //
00105     // Not a keyword, but just a final enum specifying the number of enums.
00106     NUMBER_PREDEFINED_KEYWORDS=UNDEFINED_KEYWORD
00107     };
00108 };
00109 
00110 } //# NAMESPACE CASA - END
00111 
00112 #endif