MSFieldIndex.h

Classes

MSFieldIndex -- Class to handle lookup or indexing into a MS FIELD subtable (full description)

class MSFieldIndex

Interface

Public Members
MSFieldIndex(const MSField &field)
virtual ~MSFieldIndex()
Vector<Int> matchFieldNameOrCode(const String& name)
Vector<Int> matchFieldName(const String& name)
Vector<Int> matchFieldName(const Vector<String>& names)
Vector<Int> matchSubFieldName(const String& name)
Vector<Int> matchFieldRegexOrPattern(const String& pattern, const Bool regex=False)
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)
Vector<Int> matchSourceId(const Vector<Int>& sourceIds)
Vector<Int> matchFieldCode(const String& code)
Vector<Int> matchFieldIDLT(const Int n)
Vector<Int> matchFieldIDGT(const Int n)
Vector<Int> matchFieldIDGTAndLT(const Int n0, const int n1)
Private Members
MSFieldIndex()

Description

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

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

Member Description

MSFieldIndex(const MSField &field)

Construct from an MS FIELD subtable

virtual ~MSFieldIndex()

Null destructor

Vector<Int> matchFieldNameOrCode(const String& name)

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

Vector<Int> matchFieldName(const String& name)

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

Vector<Int> matchFieldName(const Vector<String>& names)

Vector<Int> matchSubFieldName(const String& name)

ADD for file name wildcard selection

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

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

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

Vector<Int> matchSourceId(const Vector<Int>& sourceIds)

Vector<Int> matchFieldCode(const String& code)

Add for field code selection

Vector<Int> matchFieldIDLT(const Int n)

Vector<Int> matchFieldIDGT(const Int n)

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

MSFieldIndex()

Disallow null constructor