casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
MSWeatherEnums.h
Go to the documentation of this file.
00001 //# MSWeatherEnums.h: Definitions for the MeasurementSet WEATHER 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: MSWeatherEnums.h 18093 2004-11-30 17:51:10Z ddebonis $
00028 
00029 #ifndef MS_MSWEATHERENUMS_H
00030 #define MS_MSWEATHERENUMS_H
00031 
00032 #include <casa/aips.h>
00033 
00034 namespace casa { //# NAMESPACE CASA - BEGIN
00035 
00036 // <use visibility=export>
00037 
00038 // <summary> Enums for the MeasurementSet WEATHER table </summary>
00039 // <reviewed reviewer="UNKNOWN" date="before2004/08/25" tests="" demos="">
00040 // </reviewed>
00041 // <etymology>
00042 // This class contains the enums for the MeasurementSet WEATHER table
00043 // </etymology>
00044 // <synopsis>
00045 // This class does nothing.  It is merely a container for the enumerations
00046 // used by the MSWeather class.  These enumerations define the
00047 // standard columns, keywords.
00048 // </synopsis>
00049 
00050 // <example>
00051 // See the documentation for MeasurementSet for examples on the use of these
00052 // enumerations.
00053 // </example>
00054 // <todo asof="1999/01/22">
00055 // All the todo items which may be related to this class are
00056 // grouped with the todo items for MeasurementSet
00057 // </todo>
00058 //
00059 
00060 class MSWeatherEnums {
00061 public:
00062     // The WEATHER table colums with predefined meaning.
00063     // Keys: ANTENNA_ID, TIME, INTERVAL.
00064     enum PredefinedColumns {
00065     // "True" columns are defined.<BR>
00066     // TYPE - UNIT - MEASURE
00067     UNDEFINED_COLUMN=0,
00068     // Antenna number<BR>
00069     // Int
00070     ANTENNA_ID,
00071     // Interval over which data is relevant <BR>
00072     // Double - s
00073     INTERVAL,
00074     // An MEpoch specifying the midpoint of the time for which data is
00075     // relevant <BR>
00076     // Double - s - EPOCH
00077     TIME,
00078     // The number of required columns <BR>
00079     NUMBER_REQUIRED_COLUMNS=TIME,
00080     // Dew point <BR>
00081     // Float - K
00082     DEW_POINT,
00083     // Flag for dew point <BR>
00084     // Bool
00085     DEW_POINT_FLAG,
00086     // Average column density of water-vapor <BR>
00087     // Float - m
00088     H2O,
00089     // Flag for H2O <BR>
00090     // Bool
00091     H2O_FLAG,
00092     // Average column density of electrons <BR>
00093     // Float - m^-2
00094     IONOS_ELECTRON,
00095     // Flag for IONOS_ELECTRON <BR>
00096     // Bool
00097     IONOS_ELECTRON_FLAG,
00098     // Ambient atmospheric pressure <BR>
00099     // Float - Pa
00100     PRESSURE,
00101     // Flag for pressure <BR>
00102     // Bool
00103     PRESSURE_FLAG,
00104     // Ambient relative humidity <BR>
00105     // Float - \%
00106     REL_HUMIDITY, 
00107     // Flag for rel humidity <BR>
00108     // Bool
00109     REL_HUMIDITY_FLAG,
00110     // Ambient Air Temperature for an antenna <BR>
00111     // Float - K
00112     TEMPERATURE,
00113     // Flag for temperature <BR>
00114     // Bool
00115     TEMPERATURE_FLAG,
00116     // Average wind direction <BR>
00117     // Float - rad 
00118     WIND_DIRECTION,
00119     // Flag for wind direction <BR>
00120     // Bool 
00121     WIND_DIRECTION_FLAG,
00122     // Average wind speed <BR>
00123     // Float - m/s
00124     WIND_SPEED,
00125     // Flag for  wind speed <BR>
00126     // Bool
00127     WIND_SPEED_FLAG,
00128     //
00129     // Not a column, but just a final enum specifying the number of enums.
00130     NUMBER_PREDEFINED_COLUMNS=WIND_SPEED_FLAG
00131     };
00132   
00133     // Keywords with a predefined meaning
00134     enum PredefinedKeywords {
00135     //
00136     // "True" keywords are defined. 
00137     UNDEFINED_KEYWORD=0,
00138     //
00139     // Not a keyword, but just a final enum specifying the number of enums.
00140     NUMBER_PREDEFINED_KEYWORDS=0
00141     };
00142 };
00143 
00144 } //# NAMESPACE CASA - END
00145 
00146 #endif