casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
MSPolEnums.h
Go to the documentation of this file.
00001 //# MSPolarizationEnums.h: Definitions for the MeasurementSet POLARIZATION table
00002 //# Copyright (C) 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: MSPolEnums.h 18093 2004-11-30 17:51:10Z ddebonis $
00028 
00029 #ifndef MS_MSPOLENUMS_H
00030 #define MS_MSPOLENUMS_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 POLARIZATION 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 POLARIZATION table
00043 // </etymology>
00044 // <synopsis>
00045 // This class does nothing. It is merely a container for the enumerations
00046 // used by the MSPolarization class.  These enumerations define the
00047 // standard columns and 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/14">
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 MSPolarizationEnums {
00061 public:
00062     // The POLARIZATION table colums with predefined meaning.
00063     // Keys: POLARIZATION_ID is rownumber
00064     enum PredefinedColumns {
00065     // "True" columns are defined.<BR>
00066     // TYPE - UNIT - MEASURE
00067     UNDEFINED_COLUMN=0,
00068     // A pair of integers for each correlation product specifying the receptors
00069     // from which the signal originated. E.g., (0,1) = receptor 0 on feed1 and
00070     // receptor 1 on feed2. This is unused for I,Q,U,V data.<BR>
00071     // Int(2, NUM_CORR)
00072     CORR_PRODUCT,
00073     // The polarization type for each correlation product, as a Stokes enum. <BR>
00074     // Int(NUM_CORR)
00075     CORR_TYPE,
00076     // Row flag <BR>
00077     // Bool
00078     FLAG_ROW,
00079     // Number of correlations. <BR>
00080     // Int
00081     NUM_CORR,
00082     // Number of required columns <BR>
00083     NUMBER_REQUIRED_COLUMNS=NUM_CORR,
00084     // Not a column, but just a final enum specifying the number of enums.
00085     NUMBER_PREDEFINED_COLUMNS=NUMBER_REQUIRED_COLUMNS
00086     };
00087   
00088     // Keywords with a predefined meaning
00089     enum PredefinedKeywords {
00090     //
00091     // "True" keywords are defined. 
00092     UNDEFINED_KEYWORD=0,
00093     //
00094     // Not a keyword, but just a final enum specifying the number of enums.
00095     NUMBER_PREDEFINED_KEYWORDS=0
00096     };
00097 };
00098 
00099 } //# NAMESPACE CASA - END
00100 
00101 #endif