casa::MSObservationColumns Class Reference
[MeasurementSets]

#include <MSObsColumns.h>

Inheritance diagram for casa::MSObservationColumns:

[legend]Collaboration diagram for casa::MSObservationColumns:

[legend]List of all members.

Detailed Description

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

Intended use:

Part of API

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.

Constructor & Destructor Documentation

casa::MSObservationColumns::MSObservationColumns ( MSObservation & msObservation )

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

casa::MSObservationColumns::~MSObservationColumns ( )

The desctructor does nothing special.

casa::MSObservationColumns::MSObservationColumns ( ) [protected]

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

Member Function Documentation

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

Read-write access to required columns.

Definition at line 191 of file MSObsColumns.h.

References flagRow_p.

ArrayColumn<String>& casa::MSObservationColumns::log ( ) [inline]

Definition at line 192 of file MSObsColumns.h.

References log_p.

ScalarColumn<String>& casa::MSObservationColumns::observer ( ) [inline]

Definition at line 193 of file MSObsColumns.h.

References observer_p.

ScalarColumn<String>& casa::MSObservationColumns::project ( ) [inline]

Definition at line 194 of file MSObsColumns.h.

References project_p.

ScalarColumn<Double>& casa::MSObservationColumns::releaseDate ( ) [inline]

Definition at line 195 of file MSObsColumns.h.

References releaseDate_p.

ScalarQuantColumn<Double>& casa::MSObservationColumns::releaseDateQuant ( ) [inline]

Definition at line 196 of file MSObsColumns.h.

References releaseDateQuant_p.

ScalarMeasColumn<MEpoch>& casa::MSObservationColumns::releaseDateMeas ( ) [inline]

Definition at line 197 of file MSObsColumns.h.

References releaseDateMeas_p.

ArrayColumn<String>& casa::MSObservationColumns::schedule ( ) [inline]

Definition at line 198 of file MSObsColumns.h.

References schedule_p.

ScalarColumn<String>& casa::MSObservationColumns::scheduleType ( ) [inline]

Definition at line 199 of file MSObsColumns.h.

References scheduleType_p.

ScalarColumn<String>& casa::MSObservationColumns::telescopeName ( ) [inline]

Definition at line 200 of file MSObsColumns.h.

References telescopeName_p.

ArrayColumn<Double>& casa::MSObservationColumns::timeRange ( ) [inline]

Definition at line 201 of file MSObsColumns.h.

References timeRange_p.

ArrayQuantColumn<Double>& casa::MSObservationColumns::timeRangeQuant ( ) [inline]

Definition at line 202 of file MSObsColumns.h.

References timeRangeQuant_p.

ArrayMeasColumn<MEpoch>& casa::MSObservationColumns::timeRangeMeas ( ) [inline]

Definition at line 203 of file MSObsColumns.h.

References timeRangeMeas_p.

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

Read-only access to required columns.

Reimplemented from casa::ROMSObservationColumns.

Definition at line 208 of file MSObsColumns.h.

References casa::ROMSObservationColumns::flagRow().

const ROArrayColumn<String>& casa::MSObservationColumns::log ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 210 of file MSObsColumns.h.

References casa::log().

const ROScalarColumn<String>& casa::MSObservationColumns::observer ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 212 of file MSObsColumns.h.

References casa::ROMSObservationColumns::observer().

const ROScalarColumn<String>& casa::MSObservationColumns::project ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 214 of file MSObsColumns.h.

References casa::ROMSObservationColumns::project().

const ROScalarColumn<Double>& casa::MSObservationColumns::releaseDate ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 216 of file MSObsColumns.h.

References casa::ROMSObservationColumns::releaseDate().

const ROScalarQuantColumn<Double>& casa::MSObservationColumns::releaseDateQuant ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 218 of file MSObsColumns.h.

References casa::ROMSObservationColumns::releaseDateQuant().

const ROScalarMeasColumn<MEpoch>& casa::MSObservationColumns::releaseDateMeas ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 220 of file MSObsColumns.h.

References casa::ROMSObservationColumns::releaseDateMeas().

const ROArrayColumn<String>& casa::MSObservationColumns::schedule ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 222 of file MSObsColumns.h.

References casa::ROMSObservationColumns::schedule().

const ROScalarColumn<String>& casa::MSObservationColumns::scheduleType ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 224 of file MSObsColumns.h.

References casa::ROMSObservationColumns::scheduleType().

const ROScalarColumn<String>& casa::MSObservationColumns::telescopeName ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 226 of file MSObsColumns.h.

References casa::ROMSObservationColumns::telescopeName().

const ROArrayColumn<Double>& casa::MSObservationColumns::timeRange ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 228 of file MSObsColumns.h.

References casa::ROMSObservationColumns::timeRange().

const ROArrayQuantColumn<Double>& casa::MSObservationColumns::timeRangeQuant ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 230 of file MSObsColumns.h.

References casa::ROMSObservationColumns::timeRangeQuant().

const ROArrayMeasColumn<MEpoch>& casa::MSObservationColumns::timeRangeMeas ( ) const [inline]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 232 of file MSObsColumns.h.

References casa::ROMSObservationColumns::timeRangeMeas().

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.

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

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

Member Data Documentation

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

Reimplemented from casa::ROMSObservationColumns.

Definition at line 262 of file MSObsColumns.h.

Referenced by flagRow().

ArrayColumn<String> casa::MSObservationColumns::log_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 263 of file MSObsColumns.h.

Referenced by log().

ScalarColumn<String> casa::MSObservationColumns::observer_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 264 of file MSObsColumns.h.

Referenced by observer().

ScalarColumn<String> casa::MSObservationColumns::project_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 265 of file MSObsColumns.h.

Referenced by project().

ScalarColumn<Double> casa::MSObservationColumns::releaseDate_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 266 of file MSObsColumns.h.

Referenced by releaseDate().

ArrayColumn<String> casa::MSObservationColumns::schedule_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 267 of file MSObsColumns.h.

Referenced by schedule().

ScalarColumn<String> casa::MSObservationColumns::scheduleType_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 268 of file MSObsColumns.h.

Referenced by scheduleType().

ScalarColumn<String> casa::MSObservationColumns::telescopeName_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 269 of file MSObsColumns.h.

Referenced by telescopeName().

ArrayColumn<Double> casa::MSObservationColumns::timeRange_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 270 of file MSObsColumns.h.

Referenced by timeRange().

ScalarMeasColumn<MEpoch> casa::MSObservationColumns::releaseDateMeas_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 273 of file MSObsColumns.h.

Referenced by releaseDateMeas().

ArrayMeasColumn<MEpoch> casa::MSObservationColumns::timeRangeMeas_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 274 of file MSObsColumns.h.

Referenced by timeRangeMeas().

ScalarQuantColumn<Double> casa::MSObservationColumns::releaseDateQuant_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 277 of file MSObsColumns.h.

Referenced by releaseDateQuant().

ArrayQuantColumn<Double> casa::MSObservationColumns::timeRangeQuant_p [private]

Reimplemented from casa::ROMSObservationColumns.

Definition at line 278 of file MSObsColumns.h.

Referenced by timeRangeQuant().

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

ms/implement/MeasurementSets/MSObsColumns.h

Generated on Mon Sep 1 22:46:55 2008 for NRAOCASA by

1.5.1


Public Member Functions
	MSObservationColumns (MSObservation &msObservation)
	Create a columns object that accesses the data in the specified Table.
	~MSObservationColumns ()
	The desctructor does nothing special.
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch type for the TIME_RANGE & RELEASE_DATE columns.

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
Protected Member Functions
	MSObservationColumns ()
void	attach (MSObservation &msObservation)
Private Member Functions
	MSObservationColumns (const MSObservationColumns &)
MSObservationColumns &	operator= (const MSObservationColumns &)
Private Attributes
ScalarColumn< Bool >	flagRow_p
ArrayColumn< String >	log_p
ScalarColumn< String >	observer_p
ScalarColumn< String >	project_p
ScalarColumn< Double >	releaseDate_p
ArrayColumn< String >	schedule_p
ScalarColumn< String >	scheduleType_p
ScalarColumn< String >	telescopeName_p
ArrayColumn< Double >	timeRange_p
ScalarMeasColumn< MEpoch >	releaseDateMeas_p
ArrayMeasColumn< MEpoch >	timeRangeMeas_p
ScalarQuantColumn< Double >	releaseDateQuant_p
ArrayQuantColumn< Double >	timeRangeQuant_p

casa::MSObservationColumns Class Reference [MeasurementSets]

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

casa::MSObservationColumns Class Reference
[MeasurementSets]