casacore::MSDopplerColumns Class Reference

A class to provide easy access to MSDoppler columns. More...

#include <MSDopplerColumns.h>

Public Member Functions
	MSDopplerColumns (const MSDoppler &msDoppler)
	Create a columns object that accesses the data in the specified Table. More...
	~MSDopplerColumns ()
	The destructor does nothing special. More...
Bool	isNull () const
	Is this object defined? (MSDoppler table is optional) More...
ScalarColumn< Int > &	dopplerId ()
	Access to required columns. More...
ScalarColumn< Int > &	sourceId ()
ScalarColumn< Int > &	transitionId ()
ScalarColumn< Double > &	velDef ()
ScalarQuantColumn< Double > &	velDefQuant ()
ScalarMeasColumn< MDoppler > &	velDefMeas ()
const ScalarColumn< Int > &	dopplerId () const
	Const access to required columns. More...
const ScalarColumn< Int > &	sourceId () const
const ScalarColumn< Int > &	transitionId () const
const ScalarColumn< Double > &	velDef () const
const ScalarQuantColumn< Double > &	velDefQuant () const
const ScalarMeasColumn < MDoppler > &	velDefMeas () const
rownr_t	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...
void	setVelDefRef (MDoppler::Types ref)
	set the DOPPLER type for the VELDEF column. More...

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

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

Private Attributes
Bool	isNull_p
ScalarColumn< Int >	dopplerId_p
ScalarColumn< Int >	sourceId_p
ScalarColumn< Int >	transitionId_p
ScalarColumn< Double >	velDef_p
ScalarMeasColumn< MDoppler >	velDefMeas_p
ScalarQuantColumn< Double >	velDefQuant_p

Detailed Description

A class to provide easy access to MSDoppler columns.

Intended use:

Public interface

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MSDoppler
• ScalarColumn

Etymology

MSDopplerColumns stands for MeasurementSet Doppler Table columns.

Synopsis

This class provides 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 MSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 74 of file MSDopplerColumns.h.

Constructor & Destructor Documentation

casacore::MSDopplerColumns::MSDopplerColumns

(

const MSDoppler &

msDoppler

)

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

casacore::MSDopplerColumns::~MSDopplerColumns

(

)

The destructor does nothing special.

casacore::MSDopplerColumns::MSDopplerColumns ( )

protected

casacore::MSDopplerColumns::MSDopplerColumns ( const MSDopplerColumns &  )

private

Member Function Documentation

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

protected

ScalarColumn<Int>& casacore::MSDopplerColumns::dopplerId ( )

inline

Access to required columns.

Definition at line 88 of file MSDopplerColumns.h.

References dopplerId_p.

const ScalarColumn<Int>& casacore::MSDopplerColumns::dopplerId ( ) const

inline

Const access to required columns.

Definition at line 98 of file MSDopplerColumns.h.

References dopplerId_p.

Bool casacore::MSDopplerColumns::isNull ( ) const

inline

Is this object defined? (MSDoppler table is optional)

Definition at line 84 of file MSDopplerColumns.h.

References isNull_p.

Referenced by nrow().

rownr_t casacore::MSDopplerColumns::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 108 of file MSDopplerColumns.h.

References dopplerId_p, isNull(), and casacore::TableColumn::nrow().

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

private

void casacore::MSDopplerColumns::setVelDefRef

(

MDoppler::Types

ref

)

set the DOPPLER type for the VELDEF column.

ScalarColumn<Int>& casacore::MSDopplerColumns::sourceId ( )

inline

Definition at line 89 of file MSDopplerColumns.h.

References sourceId_p.

const ScalarColumn<Int>& casacore::MSDopplerColumns::sourceId ( ) const

inline

Definition at line 99 of file MSDopplerColumns.h.

References sourceId_p.

ScalarColumn<Int>& casacore::MSDopplerColumns::transitionId ( )

inline

Definition at line 90 of file MSDopplerColumns.h.

References transitionId_p.

const ScalarColumn<Int>& casacore::MSDopplerColumns::transitionId ( ) const

inline

Definition at line 100 of file MSDopplerColumns.h.

References transitionId_p.

ScalarColumn<Double>& casacore::MSDopplerColumns::velDef ( )

inline

Definition at line 91 of file MSDopplerColumns.h.

References velDef_p.

const ScalarColumn<Double>& casacore::MSDopplerColumns::velDef ( ) const

inline

Definition at line 101 of file MSDopplerColumns.h.

References velDef_p.

ScalarMeasColumn<MDoppler>& casacore::MSDopplerColumns::velDefMeas ( )

inline

Definition at line 93 of file MSDopplerColumns.h.

References velDefMeas_p.

const ScalarMeasColumn<MDoppler>& casacore::MSDopplerColumns::velDefMeas ( ) const

inline

Definition at line 103 of file MSDopplerColumns.h.

References velDefMeas_p.

ScalarQuantColumn<Double>& casacore::MSDopplerColumns::velDefQuant ( )

inline

Definition at line 92 of file MSDopplerColumns.h.

References velDefQuant_p.

const ScalarQuantColumn<Double>& casacore::MSDopplerColumns::velDefQuant ( ) const

inline

Definition at line 102 of file MSDopplerColumns.h.

References velDefQuant_p.

Member Data Documentation

ScalarColumn<Int> casacore::MSDopplerColumns::dopplerId_p

private

Definition at line 131 of file MSDopplerColumns.h.

Referenced by dopplerId(), and nrow().

Bool casacore::MSDopplerColumns::isNull_p

private

Definition at line 128 of file MSDopplerColumns.h.

Referenced by isNull().

ScalarColumn<Int> casacore::MSDopplerColumns::sourceId_p

private

Definition at line 132 of file MSDopplerColumns.h.

Referenced by sourceId().

ScalarColumn<Int> casacore::MSDopplerColumns::transitionId_p

private

Definition at line 133 of file MSDopplerColumns.h.

Referenced by transitionId().

ScalarColumn<Double> casacore::MSDopplerColumns::velDef_p

private

Definition at line 134 of file MSDopplerColumns.h.

Referenced by velDef().

ScalarMeasColumn<MDoppler> casacore::MSDopplerColumns::velDefMeas_p

private

Definition at line 137 of file MSDopplerColumns.h.

Referenced by velDefMeas().

ScalarQuantColumn<Double> casacore::MSDopplerColumns::velDefQuant_p

private

Definition at line 140 of file MSDopplerColumns.h.

Referenced by velDefQuant().

---

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

• ms/MeasurementSets/MSDopplerColumns.h