casa::MSProcessorColumns Class Reference
[MeasurementSets]

#include <MSProcessorColumns.h>

Inheritance diagram for casa::MSProcessorColumns:

Inheritance graph
[legend]
Collaboration diagram for casa::MSProcessorColumns:

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Intended use:

Part of API

Review Status

Reviewed By:
Bob Garwood
Date Reviewed:
1997/02/01

Prerequisite

Etymology

MSProcessorColumns stands for MeasurementSet Processor Table columns.

Synopsis

This class provides access to the columns in the MSProcessor 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 157 of file MSProcessorColumns.h.

Public Member Functions

 MSProcessorColumns (MSProcessor &msProcessor)
 Create a columns object that accesses the data in the specified Table.
 ~MSProcessorColumns ()
 The destructor does nothing special.
ScalarColumn< Bool > & flagRow ()
 Read-write access to required columns.
ScalarColumn< Int > & modeId ()
ScalarColumn< String > & type ()
ScalarColumn< Int > & typeId ()
ScalarColumn< String > & subType ()
ScalarColumn< Int > & passId ()
 Read-write access to optional columns.
const ROScalarColumn< Bool > & flagRow () const
 Read-only access to required columns.
const ROScalarColumn< Int > & modeId () const
const ROScalarColumn< String > & type () const
const ROScalarColumn< Int > & typeId () const
const ROScalarColumn< String > & subType () const
const ROScalarColumn< Int > & passId () const
 Read-only access to optional columns.

Protected Member Functions

 MSProcessorColumns ()
void attach (MSProcessor &msProcessor)

Private Member Functions

 MSProcessorColumns (const MSProcessorColumns &)
MSProcessorColumnsoperator= (const MSProcessorColumns &)
void attachOptionalCols (MSProcessor &msProcessor)

Private Attributes

ScalarColumn< BoolflagRow_p
ScalarColumn< IntmodeId_p
ScalarColumn< Stringtype_p
ScalarColumn< InttypeId_p
ScalarColumn< StringsubType_p
ScalarColumn< IntpassId_p


Constructor & Destructor Documentation

casa::MSProcessorColumns::MSProcessorColumns ( MSProcessor msProcessor  ) 

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

casa::MSProcessorColumns::~MSProcessorColumns (  ) 

The destructor does nothing special.

casa::MSProcessorColumns::MSProcessorColumns (  )  [protected]

casa::MSProcessorColumns::MSProcessorColumns ( const MSProcessorColumns  )  [private]


Member Function Documentation

ScalarColumn<Bool>& casa::MSProcessorColumns::flagRow (  )  [inline]

Read-write access to required columns.

Definition at line 168 of file MSProcessorColumns.h.

References flagRow_p.

ScalarColumn<Int>& casa::MSProcessorColumns::modeId (  )  [inline]

Definition at line 169 of file MSProcessorColumns.h.

References modeId_p.

ScalarColumn<String>& casa::MSProcessorColumns::type (  )  [inline]

Definition at line 170 of file MSProcessorColumns.h.

References type_p.

ScalarColumn<Int>& casa::MSProcessorColumns::typeId (  )  [inline]

Definition at line 171 of file MSProcessorColumns.h.

References typeId_p.

ScalarColumn<String>& casa::MSProcessorColumns::subType (  )  [inline]

Definition at line 172 of file MSProcessorColumns.h.

References subType_p.

ScalarColumn<Int>& casa::MSProcessorColumns::passId (  )  [inline]

Read-write access to optional columns.

Definition at line 177 of file MSProcessorColumns.h.

References passId_p.

const ROScalarColumn<Bool>& casa::MSProcessorColumns::flagRow (  )  const [inline]

Read-only access to required columns.

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 182 of file MSProcessorColumns.h.

References casa::ROMSProcessorColumns::flagRow().

const ROScalarColumn<Int>& casa::MSProcessorColumns::modeId (  )  const [inline]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 184 of file MSProcessorColumns.h.

References casa::ROMSProcessorColumns::modeId().

const ROScalarColumn<String>& casa::MSProcessorColumns::type (  )  const [inline]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 186 of file MSProcessorColumns.h.

References casa::type().

const ROScalarColumn<Int>& casa::MSProcessorColumns::typeId (  )  const [inline]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 188 of file MSProcessorColumns.h.

References casa::ROMSProcessorColumns::typeId().

const ROScalarColumn<String>& casa::MSProcessorColumns::subType (  )  const [inline]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 190 of file MSProcessorColumns.h.

References casa::ROMSProcessorColumns::subType().

const ROScalarColumn<Int>& casa::MSProcessorColumns::passId (  )  const [inline]

Read-only access to optional columns.

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 196 of file MSProcessorColumns.h.

References casa::ROMSProcessorColumns::passId().

void casa::MSProcessorColumns::attach ( MSProcessor msProcessor  )  [protected]

MSProcessorColumns& casa::MSProcessorColumns::operator= ( const MSProcessorColumns  )  [private]

void casa::MSProcessorColumns::attachOptionalCols ( MSProcessor msProcessor  )  [private]


Member Data Documentation

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

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 218 of file MSProcessorColumns.h.

Referenced by flagRow().

ScalarColumn<Int> casa::MSProcessorColumns::modeId_p [private]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 219 of file MSProcessorColumns.h.

Referenced by modeId().

ScalarColumn<String> casa::MSProcessorColumns::type_p [private]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 220 of file MSProcessorColumns.h.

Referenced by type().

ScalarColumn<Int> casa::MSProcessorColumns::typeId_p [private]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 221 of file MSProcessorColumns.h.

Referenced by typeId().

ScalarColumn<String> casa::MSProcessorColumns::subType_p [private]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 222 of file MSProcessorColumns.h.

Referenced by subType().

ScalarColumn<Int> casa::MSProcessorColumns::passId_p [private]

Reimplemented from casa::ROMSProcessorColumns.

Definition at line 224 of file MSProcessorColumns.h.

Referenced by passId().


The documentation for this class was generated from the following file:
Generated on Tue Aug 26 22:35:18 2008 for NRAOCASA by  doxygen 1.5.1