MSHistoryEnums.h

Go to the documentation of this file.
00001 //# MSHistoryEnums.h: Defns for the MeasurementSet HISTORY 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$
00028 
00029 #ifndef MS_MSHISTORYENUMS_H
00030 #define MS_MSHISTORYENUMS_H
00031 
00032 #include <casacore/casa/aips.h>
00033 
00034 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00035 
00036 // <use visibility=export>
00037 
00038 // <summary> Enums for the MeasurementSet HISTORY 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 HISTORY table
00043 // </etymology>
00044 // <synopsis>
00045 // This class does nothing.  It is merely a container for the enumerations
00046 // used by the MSHistory 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/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 MSHistoryEnums {
00061 public:
00062     // The HISTORY table colums with predefined meaning.
00063     // Keys: TIME, OBSERVATION_ID
00064     enum PredefinedColumns {
00065     // "True" columns are defined.<BR>
00066     // TYPE - UNIT - MEASURE
00067     UNDEFINED_COLUMN=0,
00068     // Application name <BR>
00069     // String
00070     APPLICATION,
00071     // Application parameters <BR>
00072     // String(*)
00073     APP_PARAMS,
00074     // CLI command sequence <BR>
00075     // String(*)
00076     CLI_COMMAND,
00077     // Log message <BR>
00078     // String
00079     MESSAGE,
00080     // Originating object ID <BR>
00081     // String
00082     OBJECT_ID,
00083     // Observation id (index in OBSERVATION table) <BR>
00084     // Int
00085     OBSERVATION_ID,
00086     // (Source code) Origin of message <BR>
00087     // String
00088     ORIGIN,
00089     // Priority of message: DEBUGGING, WARN, NORMAL, SEVERE <BR>
00090     // String
00091     PRIORITY,
00092     // Timestamp of message <BR>
00093     // Double - s - EPOCH
00094     TIME,
00095     //
00096     // Number of required columns
00097     NUMBER_REQUIRED_COLUMNS=TIME,
00098     // Not a column, but just a final enum specifying the number of enums.
00099     NUMBER_PREDEFINED_COLUMNS=NUMBER_REQUIRED_COLUMNS
00100     };
00101   
00102     // Keywords with a predefined meaning
00103     enum PredefinedKeywords {
00104     //
00105     // "True" keywords are defined. 
00106     UNDEFINED_KEYWORD=0,
00107     //
00108     // Not a keyword, but just a final enum specifying the number of enums.
00109     NUMBER_PREDEFINED_KEYWORDS=0
00110     };
00111 };
00112 
00113 } //# NAMESPACE CASACORE - END
00114 
00115 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1