MSTimeGram.h

Go to the documentation of this file.

//# MSTimeGram.h: Grammar for ms time sub-expressions
//# Copyright (C) 1998
//# Associated Universities, Inc. Washington DC, USA.
//#
//# This library is free software; you can redistribute it and/or modify it
//# under the terms of the GNU Library General Public License as published by
//# the Free Software Foundation; either version 2 of the License, or (at your
//# option) any later version.
//#
//# This library is distributed in the hope that it will be useful, but WITHOUT
//# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
//# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
//# License for more details.
//#
//# You should have received a copy of the GNU Library General Public License
//# along with this library; if not, write to the Free Software Foundation,
//# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
//#
//# Correspondence concerning AIPS++ should be addressed as follows:
//#        Internet email: aips2-request@nrao.edu.
//#        Postal address: AIPS++ Project Office
//#                        National Radio Astronomy Observatory
//#                        520 Edgemont Road
//#                        Charlottesville, VA 22903-2475 USA
//#
//# $Id: MSTimeGram.h 20652 2009-07-06 05:04:32Z Malte.Marquarding $

#ifndef MS_MSTIMEGRAM_H
#define MS_MSTIMEGRAM_H


//# Includes
#include <casa/BasicSL/String.h>
#include <ms/MeasurementSets/MSTimeDefinitions.h>
#include <ms/MeasurementSets/MSTimeParse.h> // routines used by bison actions
#include <ms/MeasurementSets/MSSelectableMainColumn.h>
namespace casa { //# NAMESPACE CASA - BEGIN
  
  //# Forward Declarations
  class MeasurementSet;
  class TableExprNode;
  
  // <summary>
  // Global functions for flex/bison scanner/parser for MSTimeGram
  // </summary>
  
  // <use visibility=local>
  
  // <reviewed reviewer="" date="" tests="">
  // </reviewed>
  
  // <prerequisite>
  //# Classes you should understand before using this one.
  //  <li> MSTimeGram.l and .y  (flex and bison grammar)
  // </prerequisite>
  
  // <synopsis> 
  // Global functions are needed to define the input of the flex scanner
  // and to start the bison parser.
  // The input is taken from a string.
  // </synopsis> 
  
  // <motivation>
  // It is necessary to be able to give an image expression in ASCII.
  // This can be used in glish.
  // </motivation>
  // <todo asof="$DATE:$">
  //# A List of bugs, limitations, extensions or planned refinements.
  // </todo>
  
  // <group name=MSTimeGramFunctions>
  
  // Declare the bison parser (is implemented by bison command).
  int msTimeGramParseCommand (const MeasurementSet *ms, const String& command, const TableExprNode& otherTens);
  int msTimeGramParseCommand (const MeasurementSet *ms, const String& command, const TableExprNode& otherTens,
                              Matrix<Double>& timeList);
  int msTimeGramParseCommand (const MeasurementSet *ms, const String& command, const TableExprNode& colAsTEN, 
                              MSSelectableMainColumn& msMainColInterface, const TableExprNode& otherTens, Matrix<Double>& timeList);
  int baseMSTimeGramParseCommand (MSTimeParse* parser, const String& command, 
                                  Matrix<Double>& selectedTimeList);
    
  // The yyerror function for the parser.
  // It throws an exception with the current token.
    void MSTimeGramerror (const char*);
  
  // Give the table expression node.
  const TableExprNode *msTimeGramParseNode();
  void msTimeGramParseDeleteNode();
  
  // Give the current position in the string.
  // This can be used when parse errors occur.
  Int& msTimeGramPosition();
  
  // Declare the input routine for flex/bison.
  int msTimeGramInput (char* buf, int max_size);
  
  // A function to remove escaped characters.
  String msTimeGramRemoveEscapes (const String& in);
  
  // A function to remove quotes from a quoted string.
  //String msTimeGramRemoveQuotes (const String& in);
  
  // A function to set the fields of the TimeFields structure
  void msTimeGramSetTimeFields (struct TimeFields& tf, 
                                Int year, Int month, Int day,
                                Int hour, Int minute, Int sec, Int fsec);
  // </group>
  
} //# NAMESPACE CASA - END

#endif