casacore::ROMSDopplerColumns Class Reference

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

#include <MSDopplerColumns.h>

Inheritance diagram for casacore::ROMSDopplerColumns:

Public Member Functions
	ROMSDopplerColumns (const MSDoppler &msDoppler)
	Create a columns object that accesses the data in the specified Table. More...
	~ROMSDopplerColumns ()
	The destructor does nothing special. More...
Bool	isNull () const
	Is this object defined? (MSDoppler table is optional) More...
const ROScalarColumn< Int > &	dopplerId () const
	Access to columns. More...
const ROScalarColumn< Int > &	sourceId () const
const ROScalarColumn< Int > &	transitionId () const
const ROScalarColumn< Double > &	velDef () const
const ROScalarQuantColumn < Double > &	velDefQuant () const
const ROScalarMeasColumn < MDoppler > &	velDefMeas () const
uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...

Protected Member Functions
	ROMSDopplerColumns ()
void	attach (const MSDoppler &msDoppler)

Private Member Functions
	ROMSDopplerColumns (const ROMSDopplerColumns &)
ROMSDopplerColumns &	operator= (const ROMSDopplerColumns &)

Private Attributes
Bool	isNull_p
ROScalarColumn< Int >	dopplerId_p
ROScalarColumn< Int >	sourceId_p
ROScalarColumn< Int >	transitionId_p
ROScalarColumn< Double >	velDef_p
ROScalarMeasColumn< MDoppler >	velDefMeas_p
ROScalarQuantColumn< Double >	velDefQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MSDoppler
• ScalarColumn

Etymology

ROMSDopplerColumns stands for Read-Only MeasurementSet Doppler Table columns.

Synopsis

This class provides read-only access to the columns in the MSDoppler 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 75 of file MSDopplerColumns.h.

Constructor & Destructor Documentation

casacore::ROMSDopplerColumns::ROMSDopplerColumns

(

const MSDoppler &

msDoppler

)

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

casacore::ROMSDopplerColumns::~ROMSDopplerColumns

(

)

The destructor does nothing special.

casacore::ROMSDopplerColumns::ROMSDopplerColumns ( )

protected

casacore::ROMSDopplerColumns::ROMSDopplerColumns ( const ROMSDopplerColumns &  )

private

Member Function Documentation

void casacore::ROMSDopplerColumns::attach ( const MSDoppler &  msDoppler )

protected

const ROScalarColumn<Int>& casacore::ROMSDopplerColumns::dopplerId ( ) const

inline

Access to columns.

Definition at line 89 of file MSDopplerColumns.h.

References dopplerId_p.

Referenced by casacore::MSDopplerColumns::dopplerId().

Bool casacore::ROMSDopplerColumns::isNull ( ) const

inline

Is this object defined? (MSDoppler table is optional)

Definition at line 85 of file MSDopplerColumns.h.

References isNull_p.

Referenced by nrow().

uInt casacore::ROMSDopplerColumns::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 99 of file MSDopplerColumns.h.

References dopplerId_p, and isNull().

ROMSDopplerColumns& casacore::ROMSDopplerColumns::operator= ( const ROMSDopplerColumns &  )

private

const ROScalarColumn<Int>& casacore::ROMSDopplerColumns::sourceId ( ) const

inline

Definition at line 90 of file MSDopplerColumns.h.

References sourceId_p.

Referenced by casacore::MSDopplerColumns::sourceId().

const ROScalarColumn<Int>& casacore::ROMSDopplerColumns::transitionId ( ) const

inline

Definition at line 91 of file MSDopplerColumns.h.

References transitionId_p.

Referenced by casacore::MSDopplerColumns::transitionId().

const ROScalarColumn<Double>& casacore::ROMSDopplerColumns::velDef ( ) const

inline

Definition at line 92 of file MSDopplerColumns.h.

References velDef_p.

Referenced by casacore::MSDopplerColumns::velDef().

const ROScalarMeasColumn<MDoppler>& casacore::ROMSDopplerColumns::velDefMeas ( ) const

inline

Definition at line 94 of file MSDopplerColumns.h.

References velDefMeas_p.

Referenced by casacore::MSDopplerColumns::velDefMeas().

const ROScalarQuantColumn<Double>& casacore::ROMSDopplerColumns::velDefQuant ( ) const

inline

Definition at line 93 of file MSDopplerColumns.h.

References velDefQuant_p.

Referenced by casacore::MSDopplerColumns::velDefQuant().

Member Data Documentation

ROScalarColumn<Int> casacore::ROMSDopplerColumns::dopplerId_p

private

Definition at line 119 of file MSDopplerColumns.h.

Referenced by dopplerId(), and nrow().

Bool casacore::ROMSDopplerColumns::isNull_p

private

Definition at line 116 of file MSDopplerColumns.h.

Referenced by isNull().

ROScalarColumn<Int> casacore::ROMSDopplerColumns::sourceId_p

private

Definition at line 120 of file MSDopplerColumns.h.

Referenced by sourceId().

ROScalarColumn<Int> casacore::ROMSDopplerColumns::transitionId_p

private

Definition at line 121 of file MSDopplerColumns.h.

Referenced by transitionId().

ROScalarColumn<Double> casacore::ROMSDopplerColumns::velDef_p

private

Definition at line 122 of file MSDopplerColumns.h.

Referenced by velDef().

ROScalarMeasColumn<MDoppler> casacore::ROMSDopplerColumns::velDefMeas_p

private

Definition at line 125 of file MSDopplerColumns.h.

Referenced by velDefMeas().

ROScalarQuantColumn<Double> casacore::ROMSDopplerColumns::velDefQuant_p

private

Definition at line 128 of file MSDopplerColumns.h.

Referenced by velDefQuant().

---

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

• casa/casacore/ms/MeasurementSets/MSDopplerColumns.h