casacore
MSPolnGram.h
Go to the documentation of this file.
1 //# MSPolnGram.h: Grammar for ms field sub-expressions
2 //# Copyright (C) 1998
3 //# Associated Universities, Inc. Washington DC, USA.
4 //#
5 //# This library is free software; you can redistribute it and/or modify it
6 //# under the terms of the GNU Library General Public License as published by
7 //# the Free Software Foundation; either version 2 of the License, or (at your
8 //# option) any later version.
9 //#
10 //# This library is distributed in the hope that it will be useful, but WITHOUT
11 //# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 //# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
13 //# License for more details.
14 //#
15 //# You should have received a copy of the GNU Library General Public License
16 //# along with this library; if not, write to the Free Software Foundation,
17 //# Inc., 675 Massachusetts Ave, Cambridge, MA 02139, USA.
18 //#
19 //# Correspondence concerning AIPS++ should be addressed as follows:
20 //# Internet email: aips2-request@nrao.edu.
21 //# Postal address: AIPS++ Project Office
22 //# National Radio Astronomy Observatory
23 //# 520 Edgemont Road
24 //# Charlottesville, VA 22903-2475 USA
25 //#
26 //# $Id$
27 
28 #ifndef MS_MSPOLNGRAM_H
29 #define MS_MSPOLNGRAM_H
30 
31 
32 //# Includes
33 #include <casacore/casa/aips.h>
34 #include <casacore/casa/BasicSL/String.h>
35 #include <casacore/ms/MSSel/MSDataDescIndex.h>
36 #include <casacore/ms/MSSel/MSPolIndex.h>
37 #include <map>
38 
39 namespace casacore { //# NAMESPACE CASACORE - BEGIN
40 
41  //# Forward Declarations
42  class MeasurementSet;
43  class TableExprNode;
44 
45  // <summary>
46  // Global functions to drive the MSPolnParse class. These, for
47  // Polarization selection, need not be global functions, but are
48  // done this way to keep the interface uniform for the various
49  // selection expressions.
50  // </summary>
51 
52  // <use visibility=local>
53 
54  // <reviewed reviewer="" date="" tests="">
55  // </reviewed>
56 
57  // <prerequisite>
58  //# Classes you should understand before using this one.
59  // </prerequisite>
60 
61  // <synopsis>
62  // </synopsis>
63 
64  // <motivation>
65  // </motivation>
66  // <todo asof="$DATE:$">
67  //# A List of bugs, limitations, extensions or planned refinements.
68  // </todo>
69 
70 
71  // <group name=MSPolnGramFunctions>
72 
73  // The top level interface to the parser.
74  int msPolnGramParseCommand (const MeasurementSet *ms, const String& command,
75  TableExprNode& node,
76  Vector<Int>& selectedDDIDs,
77  std::map<Int, Vector<Int> >& selectedPolnMap,
78  std::map<Int, Vector<Vector<Int> > >& selectedSetupMap
79  );
80 
81  // The error handler.
82  // It throws an exception with the current token.
83  void MSPolnGramerror (char*);
84 
85  // Give the table expression node.
86  const TableExprNode *msPolnGramParseNode();
87  void msPolnGramParseDeleteNode();
88 
89  // Give the current position in the string.
90  // This can be used when parse errors occur.
91  int& msPolnGramPosition();
92 
93  // </group>
94 
95 } //# NAMESPACE CASACORE - END
96 
97 #endif
casacore::MSPolnGram_global_functions_MSPolnGramFunctions
Global functions to drive the MSPolnParse class. These, for Polarization selection,...
Definition: MSPolnGram.h:72
casacore::MSPolnGram_global_functions_MSPolnGramFunctions::msPolnGramPosition
int & msPolnGramPosition()
Give the current position in the string.
casacore::Int
int Int
Definition: aipstype.h:50
casacore
this file contains all the compiler specific defines
Definition: mainpage.dox:28
casacore::TableExprNode
Handle class for a table column expression tree.
Definition: ExprNode.h:155
casacore::MeasurementSet
A Table intended to hold astronomical data (a set of Measurements).
Definition: MeasurementSet.h:241
casacore::String
String: the storage and methods of handling collections of characters.
Definition: String.h:223
casacore::MSPolnGram_global_functions_MSPolnGramFunctions::msPolnGramParseNode
const TableExprNode * msPolnGramParseNode()
Give the table expression node.
casacore::MSPolnGram_global_functions_MSPolnGramFunctions::msPolnGramParseDeleteNode
void msPolnGramParseDeleteNode()
casacore::MSPolnGram_global_functions_MSPolnGramFunctions::msPolnGramParseCommand
int msPolnGramParseCommand(const MeasurementSet *ms, const String &command, TableExprNode &node, Vector< Int > &selectedDDIDs, std::map< Int, Vector< Int > > &selectedPolnMap, std::map< Int, Vector< Vector< Int > > > &selectedSetupMap)
The top level interface to the parser.
casacore::Vector< Int >
casacore::MSPolnGram_global_functions_MSPolnGramFunctions::MSPolnGramerror
void MSPolnGramerror(char *)
The error handler.