casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
casa::ROMSAntennaColumns Class Reference

A class to provide easy read-only access to MSAntenna columns. More...

#include <MSAntennaColumns.h>

Inheritance diagram for casa::ROMSAntennaColumns:
casa::MSAntennaColumns

List of all members.

Public Member Functions

 ROMSAntennaColumns (const MSAntenna &msAntenna)
 Create a columns object that accesses the data in the specified Table.
 ~ROMSAntennaColumns ()
 The destructor does nothing special.
const ROScalarColumn< Double > & dishDiameter () const
 Access to columns.
const ROScalarQuantColumn
< Double > & 
dishDiameterQuant () const
const ROScalarColumn< Bool > & flagRow () const
const ROScalarColumn< String > & mount () const
const ROScalarColumn< String > & name () const
const ROArrayColumn< Double > & offset () const
const ROArrayQuantColumn
< Double > & 
offsetQuant () const
const ROScalarMeasColumn
< MPosition > & 
offsetMeas () const
const ROArrayColumn< Double > & position () const
const ROArrayQuantColumn
< Double > & 
positionQuant () const
const ROScalarMeasColumn
< MPosition > & 
positionMeas () const
const ROScalarColumn< String > & station () const
const ROScalarColumn< String > & type () const
const ROArrayColumn< Double > & meanOrbit () const
 Access to optional columns.
const ROScalarColumn< Int > & orbitId () const
const ROScalarColumn< Int > & phasedArrayId () const
uInt nrow () const
 Convenience function that returns the number of rows in any of the columns.
Int matchAntenna (const MPosition &antennaPos, const Quantum< Double > &tolerance, Int tryRow=-1)
 returns the last row that contains an antenna at the specified position, to within the specified tolerance.
Int matchAntenna (const String &antName, const MPosition &antennaPos, const Quantum< Double > &tolerance, Int tryRow=-1)
 Same as the previous function except that the antenna name must also match.
Int matchAntennaAndStation (const String &antName, const String &stationName, const MPosition &antennaPos, const Quantum< Double > &tolerance, Int tryRow=-1)
 Same as the previous function except that the station name must also match.

Protected Member Functions

 ROMSAntennaColumns ()
void attach (const MSAntenna &msAntenna)

Private Member Functions

 ROMSAntennaColumns (const ROMSAntennaColumns &)
ROMSAntennaColumnsoperator= (const ROMSAntennaColumns &)
void attachOptionalCols (const MSAntenna &msAntenna)
Bool matchName (uInt row, const String &antName) const
Bool matchStation (uInt row, const String &stationName) const
Bool matchPosition (uInt row, const Vector< Double > &antPosInM, const Double tolInM) const

Private Attributes

ROScalarColumn< DoubledishDiameter_p
ROScalarColumn< BoolflagRow_p
ROScalarColumn< Stringmount_p
ROScalarColumn< Stringname_p
ROArrayColumn< Doubleoffset_p
ROArrayColumn< Doubleposition_p
ROScalarColumn< Stringstation_p
ROScalarColumn< Stringtype_p
ROArrayColumn< DoublemeanOrbit_p
ROScalarColumn< IntorbitId_p
ROScalarColumn< IntphasedArrayId_p
ROScalarMeasColumn< MPositionoffsetMeas_p
ROScalarMeasColumn< MPositionpositionMeas_p
ROScalarQuantColumn< DoubledishDiameterQuant_p
ROArrayQuantColumn< DoubleoffsetQuant_p
ROArrayQuantColumn< DoublepositionQuant_p

Detailed Description

A class to provide easy read-only access to MSAntenna columns.

Intended use:

Public interface

Review Status

Reviewed By:
Bob Garwood
Date Reviewed:
1997/02/01

Prerequisite

Etymology

ROMSAntennaColumns stands for Read-Only MeasurementSet Antenna Table columns.

Synopsis

This class provides read-only access to the columns in the MSAntenna Table. It does the declaration of all the Scalar and ArrayColumns with the correct types, so the application programmer doesn't have to worry about getting those right. There is an access function for every predefined column. Access to non-predefined columns will still have to be done with explicit declarations. See ROMSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 78 of file MSAntennaColumns.h.


Constructor & Destructor Documentation

Create a columns object that accesses the data in the specified Table.

The destructor does nothing special.


Member Function Documentation

void casa::ROMSAntennaColumns::attach ( const MSAntenna msAntenna) [protected]
void casa::ROMSAntennaColumns::attachOptionalCols ( const MSAntenna msAntenna) [private]

Access to columns.

Reimplemented in casa::MSAntennaColumns.

Definition at line 90 of file MSAntennaColumns.h.

References dishDiameter_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 91 of file MSAntennaColumns.h.

References dishDiameterQuant_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 93 of file MSAntennaColumns.h.

References flagRow_p.

Int casa::ROMSAntennaColumns::matchAntenna ( const MPosition antennaPos,
const Quantum< Double > &  tolerance,
Int  tryRow = -1 
)

returns the last row that contains an antenna at the specified position, to within the specified tolerance.

The reference frame of the supplied position must be the same as the one for the POSITION columns. If not an AipsError is thrown as such an argument will never match any row of the Table. The tolerance is the maximum allowed distance between the two positions and the supplied Quantum must have dimensions of length. This is checked when compiled in debug mode and an AipsError exception is thrown if the dimensions are wrong. Returns -1 if no match could be found. Flaged rows can never match. If tryRow is non-negative, then that row is tested to see if it matches before any others are tested. Setting tryRow to a positive value greater than the table length will throw an exception (AipsError), when compiled in debug mode.

Int casa::ROMSAntennaColumns::matchAntenna ( const String antName,
const MPosition antennaPos,
const Quantum< Double > &  tolerance,
Int  tryRow = -1 
)

Same as the previous function except that the antenna name must also match.

Int casa::ROMSAntennaColumns::matchAntennaAndStation ( const String antName,
const String stationName,
const MPosition antennaPos,
const Quantum< Double > &  tolerance,
Int  tryRow = -1 
)

Same as the previous function except that the station name must also match.

Bool casa::ROMSAntennaColumns::matchName ( uInt  row,
const String antName 
) const [private]
Bool casa::ROMSAntennaColumns::matchPosition ( uInt  row,
const Vector< Double > &  antPosInM,
const Double  tolInM 
) const [private]
Bool casa::ROMSAntennaColumns::matchStation ( uInt  row,
const String stationName 
) const [private]

Access to optional columns.

Reimplemented in casa::MSAntennaColumns.

Definition at line 111 of file MSAntennaColumns.h.

References meanOrbit_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 94 of file MSAntennaColumns.h.

References mount_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 95 of file MSAntennaColumns.h.

References name_p.

Convenience function that returns the number of rows in any of the columns.

Definition at line 117 of file MSAntennaColumns.h.

References dishDiameter_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 96 of file MSAntennaColumns.h.

References offset_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 98 of file MSAntennaColumns.h.

References offsetMeas_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 97 of file MSAntennaColumns.h.

References offsetQuant_p.

ROMSAntennaColumns& casa::ROMSAntennaColumns::operator= ( const ROMSAntennaColumns ) [private]

Reimplemented in casa::MSAntennaColumns.

Definition at line 112 of file MSAntennaColumns.h.

References orbitId_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 113 of file MSAntennaColumns.h.

References phasedArrayId_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 100 of file MSAntennaColumns.h.

References position_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 103 of file MSAntennaColumns.h.

References positionMeas_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 101 of file MSAntennaColumns.h.

References positionQuant_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 105 of file MSAntennaColumns.h.

References station_p.

Reimplemented in casa::MSAntennaColumns.

Definition at line 106 of file MSAntennaColumns.h.

References type_p.


Member Data Documentation

Reimplemented in casa::MSAntennaColumns.

Definition at line 171 of file MSAntennaColumns.h.

Referenced by dishDiameter(), and nrow().

Reimplemented in casa::MSAntennaColumns.

Definition at line 189 of file MSAntennaColumns.h.

Referenced by dishDiameterQuant().

Reimplemented in casa::MSAntennaColumns.

Definition at line 172 of file MSAntennaColumns.h.

Referenced by flagRow().

Reimplemented in casa::MSAntennaColumns.

Definition at line 180 of file MSAntennaColumns.h.

Referenced by meanOrbit().

Reimplemented in casa::MSAntennaColumns.

Definition at line 173 of file MSAntennaColumns.h.

Referenced by mount().

Reimplemented in casa::MSAntennaColumns.

Definition at line 174 of file MSAntennaColumns.h.

Referenced by name().

Reimplemented in casa::MSAntennaColumns.

Definition at line 175 of file MSAntennaColumns.h.

Referenced by offset().

Reimplemented in casa::MSAntennaColumns.

Definition at line 185 of file MSAntennaColumns.h.

Referenced by offsetMeas().

Reimplemented in casa::MSAntennaColumns.

Definition at line 190 of file MSAntennaColumns.h.

Referenced by offsetQuant().

Reimplemented in casa::MSAntennaColumns.

Definition at line 181 of file MSAntennaColumns.h.

Referenced by orbitId().

Reimplemented in casa::MSAntennaColumns.

Definition at line 182 of file MSAntennaColumns.h.

Referenced by phasedArrayId().

Reimplemented in casa::MSAntennaColumns.

Definition at line 176 of file MSAntennaColumns.h.

Referenced by position().

Reimplemented in casa::MSAntennaColumns.

Definition at line 186 of file MSAntennaColumns.h.

Referenced by positionMeas().

Reimplemented in casa::MSAntennaColumns.

Definition at line 191 of file MSAntennaColumns.h.

Referenced by positionQuant().

Reimplemented in casa::MSAntennaColumns.

Definition at line 177 of file MSAntennaColumns.h.

Referenced by station().

Reimplemented in casa::MSAntennaColumns.

Definition at line 178 of file MSAntennaColumns.h.

Referenced by type().


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