casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
casa::MSObservationColumns Class Reference

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

#include <MSObsColumns.h>

Inheritance diagram for casa::MSObservationColumns:
casa::ROMSObservationColumns

List of all members.

Public Member Functions

 MSObservationColumns (MSObservation &msObservation)
 Create a columns object that accesses the data in the specified Table.
 ~MSObservationColumns ()
 The desctructor does nothing special.
ScalarColumn< Bool > & flagRow ()
 Read-write access to required columns.
ArrayColumn< String > & log ()
ScalarColumn< String > & observer ()
ScalarColumn< String > & project ()
ScalarColumn< Double > & releaseDate ()
ScalarQuantColumn< Double > & releaseDateQuant ()
ScalarMeasColumn< MEpoch > & releaseDateMeas ()
ArrayColumn< String > & schedule ()
ScalarColumn< String > & scheduleType ()
ScalarColumn< String > & telescopeName ()
ArrayColumn< Double > & timeRange ()
ArrayQuantColumn< Double > & timeRangeQuant ()
ArrayMeasColumn< MEpoch > & timeRangeMeas ()
const ROScalarColumn< Bool > & flagRow () const
 Read-only access to required columns.
const ROArrayColumn< String > & log () const
const ROScalarColumn< String > & observer () const
const ROScalarColumn< String > & project () const
const ROScalarColumn< Double > & releaseDate () const
const ROScalarQuantColumn
< Double > & 
releaseDateQuant () const
const ROScalarMeasColumn
< MEpoch > & 
releaseDateMeas () const
const ROArrayColumn< String > & schedule () const
const ROScalarColumn< String > & scheduleType () const
const ROScalarColumn< String > & telescopeName () const
const ROArrayColumn< Double > & timeRange () const
const ROArrayQuantColumn
< Double > & 
timeRangeQuant () const
const ROArrayMeasColumn< MEpoch > & timeRangeMeas () const
void setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
 set the epoch type for the TIME_RANGE & RELEASE_DATE columns.

Protected Member Functions

 MSObservationColumns ()
void attach (MSObservation &msObservation)

Private Member Functions

 MSObservationColumns (const MSObservationColumns &)
MSObservationColumnsoperator= (const MSObservationColumns &)

Private Attributes

ScalarColumn< BoolflagRow_p
ArrayColumn< Stringlog_p
ScalarColumn< Stringobserver_p
ScalarColumn< Stringproject_p
ScalarColumn< DoublereleaseDate_p
ArrayColumn< Stringschedule_p
ScalarColumn< StringscheduleType_p
ScalarColumn< StringtelescopeName_p
ArrayColumn< DoubletimeRange_p
ScalarMeasColumn< MEpochreleaseDateMeas_p
ArrayMeasColumn< MEpochtimeRangeMeas_p
ScalarQuantColumn< DoublereleaseDateQuant_p
ArrayQuantColumn< DoubletimeRangeQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSObservationColumns stands for MeasurementSet Observation Table columns.

Synopsis

This class provides access to the columns in the MSObservation 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 181 of file MSObsColumns.h.


Constructor & Destructor Documentation

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

The desctructor does nothing special.


Member Function Documentation

void casa::MSObservationColumns::attach ( MSObservation msObservation) [protected]

Read-write access to required columns.

Definition at line 192 of file MSObsColumns.h.

References flagRow_p.

Referenced by flagRow().

Read-only access to required columns.

Reimplemented from casa::ROMSObservationColumns.

Definition at line 209 of file MSObsColumns.h.

References flagRow().

Definition at line 193 of file MSObsColumns.h.

References log_p.

Referenced by log().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 211 of file MSObsColumns.h.

References log().

Definition at line 194 of file MSObsColumns.h.

References observer_p.

Referenced by observer().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 213 of file MSObsColumns.h.

References observer().

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

Definition at line 195 of file MSObsColumns.h.

References project_p.

Referenced by project().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 215 of file MSObsColumns.h.

References project().

Definition at line 196 of file MSObsColumns.h.

References releaseDate_p.

Referenced by releaseDate().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 217 of file MSObsColumns.h.

References releaseDate().

Definition at line 198 of file MSObsColumns.h.

References releaseDateMeas_p.

Referenced by releaseDateMeas().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 221 of file MSObsColumns.h.

References releaseDateMeas().

Definition at line 197 of file MSObsColumns.h.

References releaseDateQuant_p.

Referenced by releaseDateQuant().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 219 of file MSObsColumns.h.

References releaseDateQuant().

Definition at line 199 of file MSObsColumns.h.

References schedule_p.

Referenced by schedule().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 223 of file MSObsColumns.h.

References schedule().

Definition at line 200 of file MSObsColumns.h.

References scheduleType_p.

Referenced by scheduleType().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 225 of file MSObsColumns.h.

References scheduleType().

void casa::MSObservationColumns::setEpochRef ( MEpoch::Types  ref,
Bool  tableMustBeEmpty = True 
)

set the epoch type for the TIME_RANGE & RELEASE_DATE columns.


Tip: In principle this function can only be used if the table is empty, otherwise already written values may thereafter have an incorrect reference, offset, or unit; However, it is possible that part of the table gets written before these values are known; In that case the reference, offset, or units can be set by using a False tableMustBeEmpty argument;

Definition at line 201 of file MSObsColumns.h.

References telescopeName_p.

Referenced by telescopeName().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 227 of file MSObsColumns.h.

References telescopeName().

Definition at line 202 of file MSObsColumns.h.

References timeRange_p.

Referenced by timeRange().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 229 of file MSObsColumns.h.

References timeRange().

Definition at line 204 of file MSObsColumns.h.

References timeRangeMeas_p.

Referenced by timeRangeMeas().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 233 of file MSObsColumns.h.

References timeRangeMeas().

Definition at line 203 of file MSObsColumns.h.

References timeRangeQuant_p.

Referenced by timeRangeQuant().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 231 of file MSObsColumns.h.

References timeRangeQuant().


Member Data Documentation

Reimplemented from casa::ROMSObservationColumns.

Definition at line 263 of file MSObsColumns.h.

Referenced by flagRow().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 264 of file MSObsColumns.h.

Referenced by log().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 265 of file MSObsColumns.h.

Referenced by observer().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 266 of file MSObsColumns.h.

Referenced by project().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 267 of file MSObsColumns.h.

Referenced by releaseDate().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 274 of file MSObsColumns.h.

Referenced by releaseDateMeas().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 278 of file MSObsColumns.h.

Referenced by releaseDateQuant().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 268 of file MSObsColumns.h.

Referenced by schedule().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 269 of file MSObsColumns.h.

Referenced by scheduleType().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 270 of file MSObsColumns.h.

Referenced by telescopeName().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 271 of file MSObsColumns.h.

Referenced by timeRange().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 275 of file MSObsColumns.h.

Referenced by timeRangeMeas().

Reimplemented from casa::ROMSObservationColumns.

Definition at line 279 of file MSObsColumns.h.

Referenced by timeRangeQuant().


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