Loading...
Searching...
No Matches
MSArrayParse.h
Go to the documentation of this file.
//# MSArrayParse.h: Classes to hold results from array grammar parser
//# Copyright (C) 1994,1995,1997,1998,1999,2000,2001,2003
//# 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: casa-feedback@nrao.edu.
//# Postal address: AIPS++ Project Office
//# National Radio Astronomy Observatory
//# 520 Edgemont Road
//# Charlottesville, VA 22903-2475 USA
#ifndef MS_MSARRAYPARSE_H
#define MS_MSARRAYPARSE_H
//# Includes
#include <casacore/casa/aips.h>
#include <casacore/ms/MSSel/MSParse.h>
#include <casacore/measures/Measures/MEpoch.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# Forward Declarations
// <summary>
// Class to hold values from array grammar parser
// </summary>
// <use visibility=local>
// <reviewed reviewer="" date="" tests="">
// </reviewed>
// <prerequisite>
//# Classes you should understand before using this one.
// </prerequisite>
// <etymology>
// MSArrayParse is the class used to parse a array command.
// </etymology>
// <synopsis>
// MSArrayParse is used by the parser of array sub-expression statements.
// The parser is written in Bison and Flex in files MSArrayGram.y and .l.
// The statements in there use the routines in this file to act
// upon a reduced rule.
// Since multiple tables can be given (with a shorthand), the table
// names are stored in a list. The variable names can be qualified
// by the table name and will be looked up in the appropriate table.
//
// The class MSArrayParse only contains information about a table
// used in the table command. Global variables (like a list and a vector)
// are used in MSArrayParse.cc to hold further information.
//
// Global functions are used to operate on the information.
// The main function is the global function msArrayCommand.
// It executes the given STaQL command and returns the resulting ms.
// This is, in fact, the only function to be used by a user.
// </synopsis>
// <motivation>
// It is necessary to be able to give a ms command in ASCII.
// This can be used in a CLI or in the table browser to get a subset
// of a table or to sort a table.
// </motivation>
//# <todo asof="$DATE:$">
//# A List of bugs, limitations, extensions or planned refinements.
//# </todo>
class MSArrayParse : public MSParse
{
public:
// Default constructor
MSArrayParse ();
// Associate the ms and the shorthand.
MSArrayParse (const MeasurementSet* ms);
// ~MSArrayParse() {if (node_p) delete node_p;node_p=0x0;}
const TableExprNode *selectRangeGTAndLT(const Int& n0, const Int& n1);
const TableExprNode *selectRangeGEAndLE(const Int& n0, const Int& n1);
const TableExprNode *selectArrayIds(const Vector<Int>& arrayids);
inline const TableExprNode *selectArrayIds() {return selectArrayIds(Vector<Int>(parsedIDList_p));}
const TableExprNode *selectArrayIdsGT(const Vector<Int>& arrayids);
const TableExprNode *selectArrayIdsLT(const Vector<Int>& arrayids);
const TableExprNode *selectArrayIdsGTEQ(const Vector<Int>& arrayids);
const TableExprNode *selectArrayIdsLTEQ(const Vector<Int>& arrayids);
std::vector<Int>& accumulateIDs(const Int id0, const Int id1=-1);
// Get table expression node object.
const TableExprNode node();
Vector<Int> selectedIDs() {return idList;}
void reset(){idList.resize(0);parsedIDList_p.resize(0);}
void cleanup() {}
void setMaxArray(const Int& n) {maxArrays_p=n;}
static MSArrayParse* thisMSAParser;
private:
TableExprNode node_p;
Vector<Int> idList;
std::vector<Int> parsedIDList_p;
const String colName;
void appendToIDList(const Vector<Int>& v);
Int maxArrays_p;
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSArrayParse::parsedIDList_p
std::vector< Int > parsedIDList_p
Definition MSArrayParse.h:121
casacore::MSArrayParse::selectArrayIdsLTEQ
const TableExprNode * selectArrayIdsLTEQ(const Vector< Int > &arrayids)
casacore::MSArrayParse::thisMSAParser
static MSArrayParse * thisMSAParser
Definition MSArrayParse.h:116
casacore::MSArrayParse::selectRangeGEAndLE
const TableExprNode * selectRangeGEAndLE(const Int &n0, const Int &n1)
casacore::MSArrayParse::reset
void reset()
Definition MSArrayParse.h:111
casacore::MSArrayParse::setMaxArray
void setMaxArray(const Int &n)
Definition MSArrayParse.h:114
casacore::MSArrayParse::MSArrayParse
MSArrayParse()
Default constructor.
casacore::MSArrayParse::selectedIDs
Vector< Int > selectedIDs()
Definition MSArrayParse.h:110
casacore::MSArrayParse::appendToIDList
void appendToIDList(const Vector< Int > &v)
casacore::MSArrayParse::selectRangeGTAndLT
const TableExprNode * selectRangeGTAndLT(const Int &n0, const Int &n1)
~MSArrayParse() {if (node_p) delete node_p;node_p=0x0;}
casacore::MSArrayParse::selectArrayIds
const TableExprNode * selectArrayIds(const Vector< Int > &arrayids)
casacore::MSArrayParse::MSArrayParse
MSArrayParse(const MeasurementSet *ms)
Associate the ms and the shorthand.
casacore::MSArrayParse::node_p
TableExprNode node_p
Definition MSArrayParse.h:119
casacore::MSArrayParse::selectArrayIdsLT
const TableExprNode * selectArrayIdsLT(const Vector< Int > &arrayids)
casacore::MSArrayParse::selectArrayIdsGT
const TableExprNode * selectArrayIdsGT(const Vector< Int > &arrayids)
casacore::MSArrayParse::maxArrays_p
Int maxArrays_p
Definition MSArrayParse.h:124
casacore::MSArrayParse::cleanup
void cleanup()
Definition MSArrayParse.h:112
casacore::MSArrayParse::idList
Vector< Int > idList
Definition MSArrayParse.h:120
casacore::MSArrayParse::colName
const String colName
Definition MSArrayParse.h:122
casacore::MSArrayParse::accumulateIDs
std::vector< Int > & accumulateIDs(const Int id0, const Int id1=-1)
casacore::MSArrayParse::selectArrayIds
const TableExprNode * selectArrayIds()
Definition MSArrayParse.h:100
casacore::MSArrayParse::node
const TableExprNode node()
Get table expression node object.
casacore::MSArrayParse::selectArrayIdsGTEQ
const TableExprNode * selectArrayIdsGTEQ(const Vector< Int > &arrayids)
casacore::MSParse::MSParse
MSParse()
Default constructor for List container class.
casacore::MSParse::ms
MeasurementSet * ms()
Get ms object.
casacore::MeasurementSet
Definition MeasurementSet.h:278
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::TableExprNode
Definition ExprNode.h:154
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::Int
int Int
Definition aipstype.h:48