Loading...
Searching...
No Matches
MSStateIndex.h
Go to the documentation of this file.
//# MSStateIndex: index or lookup in a MeasurementSet FIELD subtable
//# Copyright (C) 2000,2001
//# 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_MSSTATEINDEX_H
#define MS_MSSTATEINDEX_H
//# includes
#include <casacore/casa/aips.h>
#include <casacore/ms/MeasurementSets/MSState.h>
#include <casacore/ms/MSSel/MSSelectionError.h>
#include <casacore/ms/MeasurementSets/MSStateColumns.h>
#include <casacore/casa/Arrays/Vector.h>
#include <casacore/casa/BasicSL/String.h>
namespace casacore { //# NAMESPACE CASACORE - BEGIN
//# forward declarations
// <summary>
// Class to handle lookup or indexing into a MS FIELD subtable
// </summary>
// <use visibility=export>
//
// <reviewed reviewer="" date="yyyy/mm/dd" tests="" demos="">
// </reviewed>
// <prerequisite>
// <li> MeasurementSet
// <li> MSState
// </prerequisite>
//
// <etymology>
// From "MeasurementSet", "FIELD subtable" and "index".
// </etymology>
//
// <synopsis>
// This class provides lookup and indexing into an MS FIELD
// subtable. These services include returning rows numbers
// (which for the FIELD subtable are FIELD_ID's) associated
// with specific data in the subtable.
// </synopsis>
//
// <example>
// </example>
//
// <motivation>
// Collect together all subtable indexing and lookup for the
// FIELD subtable, for encapsulation and efficiency.
// </motivation>
//
// <thrown>
// <li>
// <li>
// </thrown>
//
class MSStateIndex
{
public:
// Construct from an MS FIELD subtable
MSStateIndex(const MSState &state);
// Null destructor
virtual ~MSStateIndex() {}
Vector<Int> matchStateIntent(const String& name);
Vector<Int> matchStateIntent(const Vector<String>& names);
//ADD for file name wildcard selection
Vector<Int> matchStateObsMode(const String& name);
Vector<Int> matchStateObsMode(const Vector<String>& names);
// Look up FIELD_ID's for a given pattern/regex for source name/code
Vector<Int> matchStateRegexOrPattern(const String& pattern,
const Bool regex=False);
Vector<Int> matchStateObsModeRegexOrPattern(const String& pattern,
const Bool regex=False);
// Look up FIELD_ID's for a given source id
Vector<Int> matchStateId(const Int& sourceId);
Vector<Int> matchStateId(const Vector<Int>& sourceIds);
Vector<Int> maskStateIDs(const Vector<Int>& ids);
Vector<Int> matchStateIDLT(const Int n);
Vector<Int> matchStateIDGT(const Int n);
Vector<Int> matchStateIDGTAndLT(const Int n0, const int n1);
private:
// Disallow null constructor
MSStateIndex();
// FIELD subtable column accessor
MSStateColumns msStateCols_p;
// Vector cache of field id's
Vector<Int> stateIds_p;
Int nrows_p;
Int matchAnyRegex(const Vector<String>& strList, const Regex& regex, const Int pos=0);
};
} //# NAMESPACE CASACORE - END
#endif
casacore::MSStateColumns
Definition MSStateColumns.h:71
casacore::MSStateIndex::matchStateObsMode
Vector< Int > matchStateObsMode(const String &name)
ADD for file name wildcard selection.
casacore::MSStateIndex::MSStateIndex
MSStateIndex(const MSState &state)
Construct from an MS FIELD subtable.
casacore::MSStateIndex::matchStateId
Vector< Int > matchStateId(const Vector< Int > &sourceIds)
casacore::MSStateIndex::MSStateIndex
MSStateIndex()
Disallow null constructor.
casacore::MSStateIndex::matchStateIntent
Vector< Int > matchStateIntent(const Vector< String > &names)
casacore::MSStateIndex::matchStateIDGT
Vector< Int > matchStateIDGT(const Int n)
casacore::MSStateIndex::matchStateIntent
Vector< Int > matchStateIntent(const String &name)
casacore::MSStateIndex::matchStateIDLT
Vector< Int > matchStateIDLT(const Int n)
casacore::MSStateIndex::maskStateIDs
Vector< Int > maskStateIDs(const Vector< Int > &ids)
casacore::MSStateIndex::matchStateObsMode
Vector< Int > matchStateObsMode(const Vector< String > &names)
casacore::MSStateIndex::matchStateIDGTAndLT
Vector< Int > matchStateIDGTAndLT(const Int n0, const int n1)
casacore::MSStateIndex::~MSStateIndex
virtual ~MSStateIndex()
Null destructor.
Definition MSStateIndex.h:87
casacore::MSStateIndex::matchAnyRegex
Int matchAnyRegex(const Vector< String > &strList, const Regex &regex, const Int pos=0)
casacore::MSStateIndex::matchStateId
Vector< Int > matchStateId(const Int &sourceId)
Look up FIELD_ID's for a given source id.
casacore::MSStateIndex::stateIds_p
Vector< Int > stateIds_p
Vector cache of field id's.
Definition MSStateIndex.h:118
casacore::MSStateIndex::nrows_p
Int nrows_p
Definition MSStateIndex.h:119
casacore::MSStateIndex::msStateCols_p
MSStateColumns msStateCols_p
FIELD subtable column accessor.
Definition MSStateIndex.h:115
casacore::MSStateIndex::matchStateObsModeRegexOrPattern
Vector< Int > matchStateObsModeRegexOrPattern(const String &pattern, const Bool regex=False)
casacore::MSStateIndex::matchStateRegexOrPattern
Vector< Int > matchStateRegexOrPattern(const String &pattern, const Bool regex=False)
Look up FIELD_ID's for a given pattern/regex for source name/code.
casacore::MSState
Definition MSState.h:78
casacore::Regex
Definition Regex.h:201
casacore::String
String: the storage and methods of handling collections of characters.
Definition String.h:223
casacore::Vector
Definition Vector.h:82
casacore
this file contains all the compiler specific defines
Definition mainpage.dox:28
casacore::pattern
TableExprNode pattern(const TableExprNode &node)
Definition ExprNode.h:1491
casacore::False
const Bool False
Definition aipstype.h:42
casacore::name
String name() const
Return the name of the field.
Definition RecordField.h:163
casacore::regex
TableExprNode regex(const TableExprNode &node)
Functions for regular expression matching and pattern matching.
Definition ExprNode.h:1487
casacore::Int
int Int
Definition aipstype.h:48
casacore::Bool
bool Bool
Define the standard types used by Casacore.
Definition aipstype.h:40