casacore::MSDataDescColumns Class Reference

A class to provide easy read-write access to MSDataDescription columns. More...

#include <MSDataDescColumns.h>

Inheritance diagram for casacore::MSDataDescColumns:

Public Member Functions
	MSDataDescColumns (MSDataDescription &msDataDesc)
	Create a columns object that accesses the data in the specified Table. More...
	~MSDataDescColumns ()
	The destructor does nothing special. More...
ScalarColumn< Bool > &	flagRow ()
	Read-write access to required columns. More...
ScalarColumn< Int > &	polarizationId ()
ScalarColumn< Int > &	spectralWindowId ()
ScalarColumn< Int > &	lagId ()
	read-write access to optional columns More...
const ROScalarColumn< Bool > &	flagRow () const
	Read-only access to required columns. More...
const ROScalarColumn< Int > &	polarizationId () const
const ROScalarColumn< Int > &	spectralWindowId () const
const ROScalarColumn< Int > &	lagId () const
	Read-only access to optional columns. More...
Public Member Functions inherited from casacore::ROMSDataDescColumns
	ROMSDataDescColumns (const MSDataDescription &msDataDesc)
	Create a columns object that accesses the data in the specified Table. More...
	~ROMSDataDescColumns ()
	The destructor does nothing special. More...
const ROScalarColumn< Bool > &	flagRow () const
	Access to required columns. More...
const ROScalarColumn< Int > &	polarizationId () const
const ROScalarColumn< Int > &	spectralWindowId () const
const ROScalarColumn< Int > &	lagId () const
	Access to optional columns. More...
uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...
Int	match (uInt spwId, uInt polId, Int tryRow=-1)
	returns the last row that contains the specified entries in the SPECTRAL_WINDOW_ID & POLARIZATION_ID columns. More...

Protected Member Functions
	MSDataDescColumns ()
void	attach (MSDataDescription &msDataDesc)
Protected Member Functions inherited from casacore::ROMSDataDescColumns
	ROMSDataDescColumns ()
void	attach (const MSDataDescription &msDataDesc)

Private Member Functions
	MSDataDescColumns (const MSDataDescColumns &)
MSDataDescColumns &	operator= (const MSDataDescColumns &)
void	attachOptionalCols (MSDataDescription &msDataDesc)

Private Attributes
ScalarColumn< Bool >	flagRow_p
ScalarColumn< Int >	polarizationId_p
ScalarColumn< Int >	spectralWindowId_p
ScalarColumn< Int >	lagId_p

Detailed Description

A class to provide easy read-write access to MSDataDescription columns.

Intended use:

Public interface

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MSDataDesc
• ScalarColumn

Etymology

MSDataDescColumns stands for MeasurementSet DataDescription Table columns.

Synopsis

This class provides access to the columns in the MSDataDesc 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.
Warning: The Table that is used to construct this class must not be destroyed (or go out of scope) before this class does; Otherwise the scalar and array columns use by this class will be left dangling;

Motivation

See MSColumns for the motivation.

Definition at line 168 of file MSDataDescColumns.h.

Constructor & Destructor Documentation

casacore::MSDataDescColumns::MSDataDescColumns

(

MSDataDescription &

msDataDesc

)

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

casacore::MSDataDescColumns::~MSDataDescColumns

(

)

The destructor does nothing special.

casacore::MSDataDescColumns::MSDataDescColumns ( )

protected

casacore::MSDataDescColumns::MSDataDescColumns ( const MSDataDescColumns &  )

private

Member Function Documentation

void casacore::MSDataDescColumns::attach ( MSDataDescription &  msDataDesc )

protected

void casacore::MSDataDescColumns::attachOptionalCols ( MSDataDescription &  msDataDesc )

private

ScalarColumn<Bool>& casacore::MSDataDescColumns::flagRow ( )

inline

Read-write access to required columns.

Definition at line 179 of file MSDataDescColumns.h.

References flagRow_p.

const ROScalarColumn<Bool>& casacore::MSDataDescColumns::flagRow ( ) const

inline

Read-only access to required columns.

Definition at line 191 of file MSDataDescColumns.h.

References casacore::ROMSDataDescColumns::flagRow().

ScalarColumn<Int>& casacore::MSDataDescColumns::lagId ( )

inline

read-write access to optional columns

Definition at line 186 of file MSDataDescColumns.h.

References lagId_p.

const ROScalarColumn<Int>& casacore::MSDataDescColumns::lagId ( ) const

inline

Read-only access to optional columns.

Definition at line 201 of file MSDataDescColumns.h.

References casacore::ROMSDataDescColumns::lagId().

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

private

ScalarColumn<Int>& casacore::MSDataDescColumns::polarizationId ( )

inline

Definition at line 180 of file MSDataDescColumns.h.

References polarizationId_p.

const ROScalarColumn<Int>& casacore::MSDataDescColumns::polarizationId ( ) const

inline

Definition at line 193 of file MSDataDescColumns.h.

References casacore::ROMSDataDescColumns::polarizationId().

ScalarColumn<Int>& casacore::MSDataDescColumns::spectralWindowId ( )

inline

Definition at line 181 of file MSDataDescColumns.h.

References spectralWindowId_p.

const ROScalarColumn<Int>& casacore::MSDataDescColumns::spectralWindowId ( ) const

inline

Definition at line 195 of file MSDataDescColumns.h.

References casacore::ROMSDataDescColumns::spectralWindowId().

Member Data Documentation

ScalarColumn<Bool> casacore::MSDataDescColumns::flagRow_p

private

Definition at line 223 of file MSDataDescColumns.h.

Referenced by flagRow().

ScalarColumn<Int> casacore::MSDataDescColumns::lagId_p

private

Definition at line 227 of file MSDataDescColumns.h.

Referenced by lagId().

ScalarColumn<Int> casacore::MSDataDescColumns::polarizationId_p

private

Definition at line 224 of file MSDataDescColumns.h.

Referenced by polarizationId().

ScalarColumn<Int> casacore::MSDataDescColumns::spectralWindowId_p

private

Definition at line 225 of file MSDataDescColumns.h.

Referenced by spectralWindowId().

---

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

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