casacore
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
casacore::MSDataDescColumns Class Reference

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

#include <MSDataDescColumns.h>

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 &)
 
MSDataDescColumnsoperator= (const MSDataDescColumns &)
 
void attachOptionalCols (MSDataDescription &msDataDesc)
 

Private Attributes

ScalarColumn< BoolflagRow_p
 
ScalarColumn< IntpolarizationId_p
 
ScalarColumn< IntspectralWindowId_p
 
ScalarColumn< IntlagId_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

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

◆ MSDataDescColumns() [1/3]

casacore::MSDataDescColumns::MSDataDescColumns ( MSDataDescription msDataDesc)

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

◆ ~MSDataDescColumns()

casacore::MSDataDescColumns::~MSDataDescColumns ( )

The destructor does nothing special.

◆ MSDataDescColumns() [2/3]

casacore::MSDataDescColumns::MSDataDescColumns ( )
protected

◆ MSDataDescColumns() [3/3]

casacore::MSDataDescColumns::MSDataDescColumns ( const MSDataDescColumns )
private

Member Function Documentation

◆ attach()

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

◆ attachOptionalCols()

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

◆ flagRow() [1/2]

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

Read-write access to required columns.

Definition at line 179 of file MSDataDescColumns.h.

References casacore::ROMSDataDescColumns::flagRow_p.

◆ flagRow() [2/2]

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().

◆ lagId() [1/2]

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

read-write access to optional columns

Definition at line 186 of file MSDataDescColumns.h.

References casacore::ROMSDataDescColumns::lagId_p.

◆ lagId() [2/2]

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

◆ operator=()

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

◆ polarizationId() [1/2]

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

◆ polarizationId() [2/2]

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

◆ spectralWindowId() [1/2]

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

◆ spectralWindowId() [2/2]

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

Member Data Documentation

◆ flagRow_p

ScalarColumn<Bool> casacore::MSDataDescColumns::flagRow_p
private

Definition at line 223 of file MSDataDescColumns.h.

◆ lagId_p

ScalarColumn<Int> casacore::MSDataDescColumns::lagId_p
private

Definition at line 227 of file MSDataDescColumns.h.

◆ polarizationId_p

ScalarColumn<Int> casacore::MSDataDescColumns::polarizationId_p
private

Definition at line 224 of file MSDataDescColumns.h.

◆ spectralWindowId_p

ScalarColumn<Int> casacore::MSDataDescColumns::spectralWindowId_p
private

Definition at line 225 of file MSDataDescColumns.h.


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