casa::MSDataDescColumns Class Reference

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

#include <MSDataDescColumns.h>

Inheritance diagram for casa::MSDataDescColumns:

List of all members.

Public Member Functions
	MSDataDescColumns (MSDataDescription &msDataDesc)
	Create a columns object that accesses the data in the specified Table.
	~MSDataDescColumns ()
	The destructor does nothing special.
ScalarColumn< Bool > &	flagRow ()
	Read-write access to required columns.
ScalarColumn< Int > &	polarizationId ()
ScalarColumn< Int > &	spectralWindowId ()
ScalarColumn< Int > &	lagId ()
	read-write access to optional columns
const ROScalarColumn< Bool > &	flagRow () const
	Read-only access to required columns.
const ROScalarColumn< Int > &	polarizationId () const
const ROScalarColumn< Int > &	spectralWindowId () const
const ROScalarColumn< Int > &	lagId () const
	Read-only access to optional columns.
Protected Member Functions
	MSDataDescColumns ()
void	attach (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

casa::MSDataDescColumns::MSDataDescColumns

(

MSDataDescription &

msDataDesc

)

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

casa::MSDataDescColumns::~MSDataDescColumns

(

)

The destructor does nothing special.

casa::MSDataDescColumns::MSDataDescColumns

(

)

[protected]

casa::MSDataDescColumns::MSDataDescColumns

(

const MSDataDescColumns &

)

[private]

---

Member Function Documentation

void casa::MSDataDescColumns::attach

(

MSDataDescription &

msDataDesc

)

[protected]

void casa::MSDataDescColumns::attachOptionalCols

(

MSDataDescription &

msDataDesc

)

[private]

ScalarColumn<Bool>& casa::MSDataDescColumns::flagRow

(

)

[inline]

Read-write access to required columns.

Definition at line 179 of file MSDataDescColumns.h.

References flagRow_p.

Referenced by flagRow().

const ROScalarColumn<Bool>& casa::MSDataDescColumns::flagRow

(

)

const [inline]

Read-only access to required columns.

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 191 of file MSDataDescColumns.h.

References flagRow().

ScalarColumn<Int>& casa::MSDataDescColumns::lagId

(

)

[inline]

read-write access to optional columns

Definition at line 186 of file MSDataDescColumns.h.

References lagId_p.

Referenced by lagId().

const ROScalarColumn<Int>& casa::MSDataDescColumns::lagId

(

)

const [inline]

Read-only access to optional columns.

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 201 of file MSDataDescColumns.h.

References lagId().

MSDataDescColumns& casa::MSDataDescColumns::operator=

(

const MSDataDescColumns &

)

[private]

ScalarColumn<Int>& casa::MSDataDescColumns::polarizationId

(

)

[inline]

Definition at line 180 of file MSDataDescColumns.h.

References polarizationId_p.

Referenced by polarizationId().

const ROScalarColumn<Int>& casa::MSDataDescColumns::polarizationId

(

)

const [inline]

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 193 of file MSDataDescColumns.h.

References polarizationId().

ScalarColumn<Int>& casa::MSDataDescColumns::spectralWindowId

(

)

[inline]

Definition at line 181 of file MSDataDescColumns.h.

References spectralWindowId_p.

Referenced by spectralWindowId().

const ROScalarColumn<Int>& casa::MSDataDescColumns::spectralWindowId

(

)

const [inline]

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 195 of file MSDataDescColumns.h.

References spectralWindowId().

---

Member Data Documentation

ScalarColumn<Bool> casa::MSDataDescColumns::flagRow_p [private]

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 223 of file MSDataDescColumns.h.

Referenced by flagRow().

ScalarColumn<Int> casa::MSDataDescColumns::lagId_p [private]

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 227 of file MSDataDescColumns.h.

Referenced by lagId().

ScalarColumn<Int> casa::MSDataDescColumns::polarizationId_p [private]

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 224 of file MSDataDescColumns.h.

Referenced by polarizationId().

ScalarColumn<Int> casa::MSDataDescColumns::spectralWindowId_p [private]

Reimplemented from casa::ROMSDataDescColumns.

Definition at line 225 of file MSDataDescColumns.h.

Referenced by spectralWindowId().

---

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

• casacore/ms/MeasurementSets/MSDataDescColumns.h