casacore::MSFieldIndex Class Reference

Class to handle lookup or indexing into a MS FIELD subtable. More...

#include <MSFieldIndex.h>

Public Member Functions
	MSFieldIndex (const MSField &field)
	Construct from an MS FIELD subtable. More...
virtual	~MSFieldIndex ()
	Null destructor. More...
Vector< Int >	matchFieldNameOrCode (const String &name)
	Look up a single name in FIELD.NAME or FIELD.CODE. More...
Vector< Int >	matchFieldName (const String &name)
	Look up FIELD_ID's for a given field name, or set of field names. More...
Vector< Int >	matchFieldName (const Vector< String > &names)
Vector< Int >	matchSubFieldName (const String &name)
	ADD for file name wildcard selection. More...
Vector< Int >	matchFieldRegexOrPattern (const String &pattern, const Bool regex=False)
	Look up FIELD_ID's for a given pattern/regex for source name/code. More...
Vector< Int >	matchFieldNameRegexOrPattern (const String &pattern, const Bool regex=False)
Vector< Int >	matchFieldCodeRegexOrPattern (const String &pattern, const Bool regex=False)
Vector< Int >	matchSourceId (const Int &sourceId)
	Look up FIELD_ID's for a given source id. More...
Vector< Int >	matchSourceId (const Vector< Int > &sourceIds)
void	matchIdAgainstNames (Vector< Int > &ids)
Vector< Int >	validateIndices (const Vector< Int > &sourceIds)
Vector< Int >	matchFieldCode (const String &code)
	Add for field code selection. More...
Vector< Int >	maskFieldIDs (const Vector< Int > &ids)
Vector< Int >	matchFieldIDLT (const Int n)
Vector< Int >	matchFieldIDGT (const Int n)
Vector< Int >	matchFieldIDGTAndLT (const Int n0, const int n1)

Private Member Functions
	MSFieldIndex ()
	Disallow null constructor. More...

Private Attributes
ROMSFieldColumns	msFieldCols_p
	FIELD subtable column accessor. More...
Vector< Int >	fieldIds_p
	Vector cache of field id's. More...
Int	nrows_p

Detailed Description

Class to handle lookup or indexing into a MS FIELD subtable.

Intended use:

Public interface

Review Status

Date Reviewed:

yyyy/mm/dd

Prerequisite

• MeasurementSet
• MSField

Etymology

From "MeasurementSet", "FIELD subtable" and "index".

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.

Example

Motivation

Collect together all subtable indexing and lookup for the FIELD subtable, for encapsulation and efficiency.

Thrown Exceptions

Definition at line 83 of file MSFieldIndex.h.

Constructor & Destructor Documentation

casacore::MSFieldIndex::MSFieldIndex

(

const MSField &

field

)

Construct from an MS FIELD subtable.

virtual casacore::MSFieldIndex::~MSFieldIndex ( )

inlinevirtual

Null destructor.

Definition at line 90 of file MSFieldIndex.h.

casacore::MSFieldIndex::MSFieldIndex ( )

private

Disallow null constructor.

Member Function Documentation

Vector<Int> casacore::MSFieldIndex::maskFieldIDs

(

const Vector< Int > &

ids

)

Vector<Int> casacore::MSFieldIndex::matchFieldCode

(

const String &

code

)

Add for field code selection.

Vector<Int> casacore::MSFieldIndex::matchFieldCodeRegexOrPattern	(	const String &	pattern,
		const Bool	regex = False
	)

Vector<Int> casacore::MSFieldIndex::matchFieldIDGT

(

const Int

n

)

Vector<Int> casacore::MSFieldIndex::matchFieldIDGTAndLT	(	const Int	n0,
		const int	n1
	)

Vector<Int> casacore::MSFieldIndex::matchFieldIDLT

(

const Int

n

)

Vector<Int> casacore::MSFieldIndex::matchFieldName

(

const String &

name

)

Look up FIELD_ID's for a given field name, or set of field names.

Vector<Int> casacore::MSFieldIndex::matchFieldName

(

const Vector< String > &

names

)

Vector<Int> casacore::MSFieldIndex::matchFieldNameOrCode

(

const String &

name

)

Look up a single name in FIELD.NAME or FIELD.CODE.

Vector<Int> casacore::MSFieldIndex::matchFieldNameRegexOrPattern	(	const String &	pattern,
		const Bool	regex = False
	)

Vector<Int> casacore::MSFieldIndex::matchFieldRegexOrPattern	(	const String &	pattern,
		const Bool	regex = False
	)

Look up FIELD_ID's for a given pattern/regex for source name/code.

void casacore::MSFieldIndex::matchIdAgainstNames

(

Vector< Int > &

ids

)

Vector<Int> casacore::MSFieldIndex::matchSourceId

(

const Int &

sourceId

)

Look up FIELD_ID's for a given source id.

Vector<Int> casacore::MSFieldIndex::matchSourceId

(

const Vector< Int > &

sourceIds

)

Vector<Int> casacore::MSFieldIndex::matchSubFieldName

(

const String &

name

)

ADD for file name wildcard selection.

Vector<Int> casacore::MSFieldIndex::validateIndices

(

const Vector< Int > &

sourceIds

)

Member Data Documentation

Vector<Int> casacore::MSFieldIndex::fieldIds_p

private

Vector cache of field id's.

Definition at line 130 of file MSFieldIndex.h.

ROMSFieldColumns casacore::MSFieldIndex::msFieldCols_p

private

FIELD subtable column accessor.

Definition at line 127 of file MSFieldIndex.h.

Int casacore::MSFieldIndex::nrows_p

private

Definition at line 131 of file MSFieldIndex.h.

---

The documentation for this class was generated from the following file:

• casa/casacore/ms/MSSel/MSFieldIndex.h