casacore::MSAntennaIndex Class Reference

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

#include <MSAntennaIndex.h>

List of all members.

Public Member Functions

 MSAntennaIndex (const MSAntenna &antenna)
 Construct from an MS ANTENNA subtable.
virtual ~MSAntennaIndex ()
 Null destructor.
Vector< IntmatchAntennaRegexOrPattern (const String &pattern, const Bool regex=False)
 Look up ANTENNA_ID's for a given a regular expression or pattern.
Vector< IntmatchAntennaName (const String &name)
 Look up ANTENNA_ID's for a given antenna name, or set of antenna names.
Vector< IntmatchAntennaName (const Vector< String > &names)
Vector< IntmatchStationRegexOrPattern (const String &pattern, const Bool regex=False)
 Look up ANTENNA_ID's for a given antenna station.
Vector< IntmatchStationName (const String &station)
Vector< IntmatchStationName (const Vector< String > &station)
Vector< IntmatchAntennaNameAndStation (const String &name, const String &station)
 Look up ANTENNA_ID's for a given antenna and station name pair.
Vector< IntmatchId (const Vector< Int > &sourceId)

Private Member Functions

 MSAntennaIndex ()
 Default constructor.

Private Attributes

ROMSAntennaColumns msAntennaCols_p
 ANTENNA subtable column accessor.
Vector< IntantennaIds_p
 Vector cache of antenna id's.
Vector< IntstationIds_p
Int nrows_p

Detailed Description

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

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

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

Synopsis

This class provides lookup and indexing into an MS ANTENNA subtable. These services include returning rows numbers (which for the ANTENNA subtable are ANTENNA_ID's) associated with specific data in the subtable.

Example

Motivation

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

Thrown Exceptions

Definition at line 82 of file MSAntennaIndex.h.


Constructor & Destructor Documentation

casacore::MSAntennaIndex::MSAntennaIndex ( const MSAntenna antenna  ) 

Construct from an MS ANTENNA subtable.

virtual casacore::MSAntennaIndex::~MSAntennaIndex (  )  [inline, virtual]

Null destructor.

Definition at line 89 of file MSAntennaIndex.h.

casacore::MSAntennaIndex::MSAntennaIndex (  )  [private]

Default constructor.


Member Function Documentation

Vector<Int> casacore::MSAntennaIndex::matchAntennaName ( const Vector< String > &  names  ) 
Vector<Int> casacore::MSAntennaIndex::matchAntennaName ( const String name  ) 

Look up ANTENNA_ID's for a given antenna name, or set of antenna names.

Vector<Int> casacore::MSAntennaIndex::matchAntennaNameAndStation ( const String name,
const String station 
)

Look up ANTENNA_ID's for a given antenna and station name pair.

Vector<Int> casacore::MSAntennaIndex::matchAntennaRegexOrPattern ( const String pattern,
const Bool  regex = False 
)

Look up ANTENNA_ID's for a given a regular expression or pattern.

Vector<Int> casacore::MSAntennaIndex::matchId ( const Vector< Int > &  sourceId  ) 
Vector<Int> casacore::MSAntennaIndex::matchStationName ( const Vector< String > &  station  ) 
Vector<Int> casacore::MSAntennaIndex::matchStationName ( const String station  ) 
Vector<Int> casacore::MSAntennaIndex::matchStationRegexOrPattern ( const String pattern,
const Bool  regex = False 
)

Look up ANTENNA_ID's for a given antenna station.


Member Data Documentation

Vector cache of antenna id's.

Definition at line 114 of file MSAntennaIndex.h.

ANTENNA subtable column accessor.

Definition at line 111 of file MSAntennaIndex.h.

Definition at line 115 of file MSAntennaIndex.h.

Definition at line 114 of file MSAntennaIndex.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated on 31 Aug 2016 for casa by  doxygen 1.6.1