MSTimeGram.h

Go to the documentation of this file.
00001 //# MSTimeGram.h: Grammar for ms time sub-expressions
00002 //# Copyright (C) 1998
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 //# $Id$
00027 
00028 #ifndef MS_MSTIMEGRAM_H
00029 #define MS_MSTIMEGRAM_H
00030 
00031 
00032 //# Includes
00033 #include <casacore/casa/aips.h>
00034 #include <casacore/casa/BasicSL/String.h>
00035 #include <casacore/ms/MSSel/MSTimeDefinitions.h>
00036 #include <casacore/ms/MSSel/MSTimeParse.h> // routines used by bison actions
00037 #include <casacore/ms/MSSel/MSSelectableMainColumn.h>
00038 namespace casacore { //# NAMESPACE CASACORE - BEGIN
00039   
00040   //# Forward Declarations
00041   class MeasurementSet;
00042   class TableExprNode;
00043   
00044   // <summary>
00045   // Global functions for flex/bison scanner/parser for MSTimeGram
00046   // </summary>
00047   
00048   // <use visibility=local>
00049   
00050   // <reviewed reviewer="" date="" tests="">
00051   // </reviewed>
00052   
00053   // <prerequisite>
00054   //# Classes you should understand before using this one.
00055   //  <li> MSTimeGram.l and .y  (flex and bison grammar)
00056   // </prerequisite>
00057   
00058   // <synopsis> 
00059   // Global functions are needed to define the input of the flex scanner
00060   // and to start the bison parser.
00061   // The input is taken from a string.
00062   // </synopsis> 
00063   
00064   // <motivation>
00065   // It is necessary to be able to give an image expression in ASCII.
00066   // This can be used in glish.
00067   // </motivation>
00068   // <todo asof="$DATE:$">
00069   //# A List of bugs, limitations, extensions or planned refinements.
00070   // </todo>
00071   
00072   // <group name=MSTimeGramFunctions>
00073   
00074   // Declare the bison parser (is implemented by bison command).
00075   int msTimeGramParseCommand (const MeasurementSet *ms, const String& command, const TableExprNode& otherTens);
00076   int msTimeGramParseCommand (const MeasurementSet *ms, const String& command, const TableExprNode& otherTens,
00077                               Matrix<Double>& timeList);
00078   int msTimeGramParseCommand (const MeasurementSet *ms, const String& command, const TableExprNode& colAsTEN, 
00079                               MSSelectableMainColumn& msMainColInterface, const TableExprNode& otherTens, Matrix<Double>& timeList);
00080   int baseMSTimeGramParseCommand (MSTimeParse* parser, const String& command, 
00081                                   Matrix<Double>& selectedTimeList);
00082     
00083   // The yyerror function for the parser.
00084   // It throws an exception with the current token.
00085     void MSTimeGramerror (const char*);
00086   
00087   // Give the table expression node.
00088   const TableExprNode *msTimeGramParseNode();
00089   void msTimeGramParseDeleteNode();
00090   
00091   // Give the current position in the string.
00092   // This can be used when parse errors occur.
00093   Int& msTimeGramPosition();
00094   
00095   // Declare the input routine for flex/bison.
00096   int msTimeGramInput (char* buf, int max_size);
00097   
00098   // A function to remove escaped characters.
00099   String msTimeGramRemoveEscapes (const String& in);
00100   
00101   // A function to remove quotes from a quoted string.
00102   //String msTimeGramRemoveQuotes (const String& in);
00103   
00104   // A function to set the fields of the TimeFields structure
00105   void msTimeGramSetTimeFields (struct TimeFields& tf, 
00106                                 Int year, Int month, Int day,
00107                                 Int hour, Int minute, Int sec, Int fsec);
00108   // </group>
00109   
00110 } //# NAMESPACE CASACORE - END
00111 
00112 #endif
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1