casa::ROMSSourceColumns

casa::ROMSSourceColumns Class Reference
[MeasurementSets]

#include <MSSourceColumns.h>

Inheritance diagram for casa::ROMSSourceColumns:

Inheritance graph
[legend]
List of all members.

Detailed Description

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

Intended use:

Part of API

Review Status

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

Prerequisite

Etymology

ROMSSourceColumns stands for Read-Only MeasurementSet Source Table columns.

Synopsis

This class provides read-only access to the columns in the MSSource 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 83 of file MSSourceColumns.h.

Public Member Functions

 ROMSSourceColumns (const MSSource &msSource)
 Construct from the supplied Table.
 ~ROMSSourceColumns ()
 The destructor does nothing special.
Bool isNull () const
 Is this object defined? (MSSource table is optional).
uInt nrow () const
 Convenience function that returns the number of rows in any of the columns.
const ROScalarColumn< Int > & calibrationGroup () const
 Access to required columns.
const ROScalarColumn< String > & code () const
const ROArrayColumn< Double > & direction () const
const ROArrayQuantColumn<
Double > & 		directionQuant () const
const ROScalarMeasColumn<
MDirection > & 		directionMeas () const
const ROScalarColumn< Double > & interval () const
const ROScalarQuantColumn<
Double > & 		intervalQuant () const
const ROScalarColumn< String > & name () const
const ROScalarColumn< Int > & numLines () const
const ROArrayColumn< Double > & properMotion () const
const ROArrayQuantColumn<
Double > & 		properMotionQuant () const
const ROScalarColumn< Int > & sourceId () const
const ROScalarColumn< Int > & spectralWindowId () const
const ROScalarColumn< Double > & time () const
const ROScalarQuantColumn<
Double > & 		timeQuant () const
const ROScalarMeasColumn<
MEpoch > & 		timeMeas () const
const ROArrayColumn< Double > & position () const
 Access to optional columns.
const ROArrayQuantColumn<
Double > & 		positionQuant () const
const ROScalarMeasColumn<
MPosition > & 		positionMeas () const
const ROScalarColumn< Int > & pulsarId () const
const ROArrayColumn< Double > & restFrequency () const
const ROArrayQuantColumn<
Double > & 		restFrequencyQuant () const
const ROArrayMeasColumn< MFrequency > & restFrequencyMeas () const
const ROScalarColumn< TableRecord > & sourceModel () const
const ROArrayColumn< Double > & sysvel () const
const ROArrayQuantColumn<
Double > & 		sysvelQuant () const
const ROArrayMeasColumn< MRadialVelocity > & sysvelMeas () const
const ROArrayColumn< String > & transition () const

Protected Member Functions

 ROMSSourceColumns ()
void attach (const MSSource &msSource)

Private Member Functions

 ROMSSourceColumns (const ROMSSourceColumns &)
ROMSSourceColumns & operator= (const ROMSSourceColumns &)
void attachOptionalCols (const MSSource &msSource)

Private Attributes

Bool isNull_p
ROScalarColumn< Int > calibrationGroup_p
ROScalarColumn< String > code_p
ROArrayColumn< Double > direction_p
ROScalarColumn< Double > interval_p
ROScalarColumn< String > name_p
ROScalarColumn< Int > numLines_p
ROArrayColumn< Double > properMotion_p
ROScalarColumn< Int > sourceId_p
ROScalarColumn< Int > spectralWindowId_p
ROScalarColumn< Double > time_p
ROArrayColumn< Double > position_p
ROScalarColumn< Int > pulsarId_p
ROArrayColumn< Double > restFrequency_p
ROScalarColumn< TableRecord > sourceModel_p
ROArrayColumn< Double > sysvel_p
ROArrayColumn< String > transition_p
ROScalarMeasColumn< MDirection > directionMeas_p
ROScalarMeasColumn< MEpoch > timeMeas_p
ROScalarMeasColumn< MPosition > positionMeas_p
ROArrayMeasColumn< MFrequency > restFrequencyMeas_p
ROArrayMeasColumn< MRadialVelocity > sysvelMeas_p
ROArrayQuantColumn< Double > directionQuant_p
ROScalarQuantColumn< Double > intervalQuant_p
ROArrayQuantColumn< Double > properMotionQuant_p
ROScalarQuantColumn< Double > timeQuant_p
ROArrayQuantColumn< Double > positionQuant_p
ROArrayQuantColumn< Double > restFrequencyQuant_p
ROArrayQuantColumn< Double > sysvelQuant_p

Constructor & Destructor Documentation

casa::ROMSSourceColumns::ROMSSourceColumns ( const MSSource &  msSource  ) 

Construct from the supplied Table.

casa::ROMSSourceColumns::~ROMSSourceColumns (  ) 

The destructor does nothing special.

casa::ROMSSourceColumns::ROMSSourceColumns (  )  [protected]

casa::ROMSSourceColumns::ROMSSourceColumns ( const ROMSSourceColumns &   )  [private]

Member Function Documentation

Bool casa::ROMSSourceColumns::isNull (  )  const [inline]

Is this object defined? (MSSource table is optional).

Definition at line 93 of file MSSourceColumns.h.

References isNull_p.

Referenced by nrow().

const ROScalarColumn<Int>& casa::ROMSSourceColumns::calibrationGroup (  )  const [inline]

Access to required columns.

Definition at line 97 of file MSSourceColumns.h.

References calibrationGroup_p.

Referenced by casa::MSSourceColumns::calibrationGroup().

const ROScalarColumn<String>& casa::ROMSSourceColumns::code (  )  const [inline]

Definition at line 99 of file MSSourceColumns.h.

References code_p.

Referenced by casa::MSSourceColumns::code().

const ROArrayColumn<Double>& casa::ROMSSourceColumns::direction (  )  const [inline]

Definition at line 100 of file MSSourceColumns.h.

References direction_p.

Referenced by casa::MSSourceColumns::direction().

const ROArrayQuantColumn<Double>& casa::ROMSSourceColumns::directionQuant (  )  const [inline]

Definition at line 101 of file MSSourceColumns.h.

References directionQuant_p.

Referenced by casa::MSSourceColumns::directionQuant().

const ROScalarMeasColumn<MDirection>& casa::ROMSSourceColumns::directionMeas (  )  const [inline]

Definition at line 103 of file MSSourceColumns.h.

References directionMeas_p.

Referenced by casa::MSSourceColumns::directionMeas().

const ROScalarColumn<Double>& casa::ROMSSourceColumns::interval (  )  const [inline]

Definition at line 105 of file MSSourceColumns.h.

References interval_p.

Referenced by casa::MSSourceColumns::interval().

const ROScalarQuantColumn<Double>& casa::ROMSSourceColumns::intervalQuant (  )  const [inline]

Definition at line 106 of file MSSourceColumns.h.

References intervalQuant_p.

Referenced by casa::MSSourceColumns::intervalQuant().

const ROScalarColumn<String>& casa::ROMSSourceColumns::name (  )  const [inline]

Definition at line 108 of file MSSourceColumns.h.

References name_p.

Referenced by casa::MSSourceColumns::name().

const ROScalarColumn<Int>& casa::ROMSSourceColumns::numLines (  )  const [inline]

Definition at line 109 of file MSSourceColumns.h.

References numLines_p.

Referenced by casa::MSSourceColumns::numLines().

const ROArrayColumn<Double>& casa::ROMSSourceColumns::properMotion (  )  const [inline]

Definition at line 110 of file MSSourceColumns.h.

References properMotion_p.

Referenced by casa::MSSourceColumns::properMotion().

const ROArrayQuantColumn<Double>& casa::ROMSSourceColumns::properMotionQuant (  )  const [inline]

Definition at line 111 of file MSSourceColumns.h.

References properMotionQuant_p.

Referenced by casa::MSSourceColumns::properMotionQuant().

const ROScalarColumn<Int>& casa::ROMSSourceColumns::sourceId (  )  const [inline]

Definition at line 113 of file MSSourceColumns.h.

References sourceId_p.

Referenced by casa::MSSourceColumns::sourceId().

const ROScalarColumn<Int>& casa::ROMSSourceColumns::spectralWindowId (  )  const [inline]

Definition at line 114 of file MSSourceColumns.h.

References spectralWindowId_p.

Referenced by casa::MSSourceColumns::spectralWindowId().

const ROScalarColumn<Double>& casa::ROMSSourceColumns::time (  )  const [inline]

Definition at line 116 of file MSSourceColumns.h.

References time_p.

const ROScalarQuantColumn<Double>& casa::ROMSSourceColumns::timeQuant (  )  const [inline]

Definition at line 117 of file MSSourceColumns.h.

References timeQuant_p.

Referenced by casa::MSSourceColumns::timeQuant().

const ROScalarMeasColumn<MEpoch>& casa::ROMSSourceColumns::timeMeas (  )  const [inline]

Definition at line 118 of file MSSourceColumns.h.

References timeMeas_p.

Referenced by casa::MSSourceColumns::timeMeas().

const ROArrayColumn<Double>& casa::ROMSSourceColumns::position (  )  const [inline]

Access to optional columns.

Definition at line 123 of file MSSourceColumns.h.

References position_p.

const ROArrayQuantColumn<Double>& casa::ROMSSourceColumns::positionQuant (  )  const [inline]

Definition at line 124 of file MSSourceColumns.h.

References positionQuant_p.

Referenced by casa::MSSourceColumns::positionQuant().

const ROScalarMeasColumn<MPosition>& casa::ROMSSourceColumns::positionMeas (  )  const [inline]

Definition at line 126 of file MSSourceColumns.h.

References positionMeas_p.

Referenced by casa::MSSourceColumns::positionMeas().

const ROScalarColumn<Int>& casa::ROMSSourceColumns::pulsarId (  )  const [inline]

Definition at line 128 of file MSSourceColumns.h.

References pulsarId_p.

Referenced by casa::MSSourceColumns::pulsarId().

const ROArrayColumn<Double>& casa::ROMSSourceColumns::restFrequency (  )  const [inline]

Definition at line 129 of file MSSourceColumns.h.

References restFrequency_p.

Referenced by casa::MSSourceColumns::restFrequency().

const ROArrayQuantColumn<Double>& casa::ROMSSourceColumns::restFrequencyQuant (  )  const [inline]

Definition at line 130 of file MSSourceColumns.h.

References restFrequencyQuant_p.

Referenced by casa::MSSourceColumns::restFrequencyQuant().

const ROArrayMeasColumn<MFrequency>& casa::ROMSSourceColumns::restFrequencyMeas (  )  const [inline]

Definition at line 132 of file MSSourceColumns.h.

References restFrequencyMeas_p.

Referenced by casa::MSSourceColumns::restFrequencyMeas().

const ROScalarColumn<TableRecord>& casa::ROMSSourceColumns::sourceModel (  )  const [inline]

Definition at line 134 of file MSSourceColumns.h.

References sourceModel_p.

Referenced by casa::MSSourceColumns::sourceModel().

const ROArrayColumn<Double>& casa::ROMSSourceColumns::sysvel (  )  const [inline]

Definition at line 136 of file MSSourceColumns.h.

References sysvel_p.

Referenced by casa::MSSourceColumns::sysvel().

const ROArrayQuantColumn<Double>& casa::ROMSSourceColumns::sysvelQuant (  )  const [inline]

Definition at line 137 of file MSSourceColumns.h.

References sysvelQuant_p.

Referenced by casa::MSSourceColumns::sysvelQuant().

const ROArrayMeasColumn<MRadialVelocity>& casa::ROMSSourceColumns::sysvelMeas (  )  const [inline]

Definition at line 138 of file MSSourceColumns.h.

References sysvelMeas_p.

Referenced by casa::MSSourceColumns::sysvelMeas().

const ROArrayColumn<String>& casa::ROMSSourceColumns::transition (  )  const [inline]

Definition at line 140 of file MSSourceColumns.h.

References transition_p.

Referenced by casa::MSSourceColumns::transition().

uInt casa::ROMSSourceColumns::nrow (  )  const [inline]

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

Returns zero if the object is null.

Definition at line 145 of file MSSourceColumns.h.

References calibrationGroup_p, and isNull().

void casa::ROMSSourceColumns::attach ( const MSSource &  msSource  )  [protected]

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

void casa::ROMSSourceColumns::attachOptionalCols ( const MSSource &  msSource  )  [private]

Member Data Documentation

Bool casa::ROMSSourceColumns::isNull_p [private]

Definition at line 165 of file MSSourceColumns.h.

Referenced by isNull().

ROScalarColumn<Int> casa::ROMSSourceColumns::calibrationGroup_p [private]

Definition at line 168 of file MSSourceColumns.h.

Referenced by calibrationGroup(), and nrow().

ROScalarColumn<String> casa::ROMSSourceColumns::code_p [private]

Definition at line 169 of file MSSourceColumns.h.

Referenced by code().

ROArrayColumn<Double> casa::ROMSSourceColumns::direction_p [private]

Definition at line 170 of file MSSourceColumns.h.

Referenced by direction().

ROScalarColumn<Double> casa::ROMSSourceColumns::interval_p [private]

Definition at line 171 of file MSSourceColumns.h.

Referenced by interval().

ROScalarColumn<String> casa::ROMSSourceColumns::name_p [private]

Definition at line 172 of file MSSourceColumns.h.

Referenced by name().

ROScalarColumn<Int> casa::ROMSSourceColumns::numLines_p [private]

Definition at line 173 of file MSSourceColumns.h.

Referenced by numLines().

ROArrayColumn<Double> casa::ROMSSourceColumns::properMotion_p [private]

Definition at line 174 of file MSSourceColumns.h.

Referenced by properMotion().

ROScalarColumn<Int> casa::ROMSSourceColumns::sourceId_p [private]

Definition at line 175 of file MSSourceColumns.h.

Referenced by sourceId().

ROScalarColumn<Int> casa::ROMSSourceColumns::spectralWindowId_p [private]

Definition at line 176 of file MSSourceColumns.h.

Referenced by spectralWindowId().

ROScalarColumn<Double> casa::ROMSSourceColumns::time_p [private]

Definition at line 177 of file MSSourceColumns.h.

Referenced by time().

ROArrayColumn<Double> casa::ROMSSourceColumns::position_p [private]

Definition at line 179 of file MSSourceColumns.h.

Referenced by position().

ROScalarColumn<Int> casa::ROMSSourceColumns::pulsarId_p [private]

Definition at line 180 of file MSSourceColumns.h.

Referenced by pulsarId().

ROArrayColumn<Double> casa::ROMSSourceColumns::restFrequency_p [private]

Definition at line 181 of file MSSourceColumns.h.

Referenced by restFrequency().

ROScalarColumn<TableRecord> casa::ROMSSourceColumns::sourceModel_p [private]

Definition at line 182 of file MSSourceColumns.h.

Referenced by sourceModel().

ROArrayColumn<Double> casa::ROMSSourceColumns::sysvel_p [private]

Definition at line 183 of file MSSourceColumns.h.

Referenced by sysvel().

ROArrayColumn<String> casa::ROMSSourceColumns::transition_p [private]

Definition at line 184 of file MSSourceColumns.h.

Referenced by transition().

ROScalarMeasColumn<MDirection> casa::ROMSSourceColumns::directionMeas_p [private]

Definition at line 187 of file MSSourceColumns.h.

Referenced by directionMeas().

ROScalarMeasColumn<MEpoch> casa::ROMSSourceColumns::timeMeas_p [private]

Definition at line 188 of file MSSourceColumns.h.

Referenced by timeMeas().

ROScalarMeasColumn<MPosition> casa::ROMSSourceColumns::positionMeas_p [private]

Definition at line 190 of file MSSourceColumns.h.

Referenced by positionMeas().

ROArrayMeasColumn<MFrequency> casa::ROMSSourceColumns::restFrequencyMeas_p [private]

Definition at line 191 of file MSSourceColumns.h.

Referenced by restFrequencyMeas().

ROArrayMeasColumn<MRadialVelocity> casa::ROMSSourceColumns::sysvelMeas_p [private]

Definition at line 192 of file MSSourceColumns.h.

Referenced by sysvelMeas().

ROArrayQuantColumn<Double> casa::ROMSSourceColumns::directionQuant_p [private]

Definition at line 195 of file MSSourceColumns.h.

Referenced by directionQuant().

ROScalarQuantColumn<Double> casa::ROMSSourceColumns::intervalQuant_p [private]

Definition at line 196 of file MSSourceColumns.h.

Referenced by intervalQuant().

ROArrayQuantColumn<Double> casa::ROMSSourceColumns::properMotionQuant_p [private]

Definition at line 197 of file MSSourceColumns.h.

Referenced by properMotionQuant().

ROScalarQuantColumn<Double> casa::ROMSSourceColumns::timeQuant_p [private]

Definition at line 198 of file MSSourceColumns.h.

Referenced by timeQuant().

ROArrayQuantColumn<Double> casa::ROMSSourceColumns::positionQuant_p [private]

Definition at line 200 of file MSSourceColumns.h.

Referenced by positionQuant().

ROArrayQuantColumn<Double> casa::ROMSSourceColumns::restFrequencyQuant_p [private]

Definition at line 201 of file MSSourceColumns.h.

Referenced by restFrequencyQuant().

ROArrayQuantColumn<Double> casa::ROMSSourceColumns::sysvelQuant_p [private]

Definition at line 202 of file MSSourceColumns.h.

Referenced by sysvelQuant().

The documentation for this class was generated from the following file:
Generated on Thu Jul 3 22:38:41 2008 for NRAOCASA by  doxygen 1.5.1