casacore::MSObservationColumns Class Reference

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

#include <MSObsColumns.h>

Inheritance diagram for casacore::MSObservationColumns:

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 &)
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

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

casacore::MSObservationColumns::MSObservationColumns ( MSObservation & msObservation )

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

casacore::MSObservationColumns::~MSObservationColumns ( )

The desctructor does nothing special.

casacore::MSObservationColumns::MSObservationColumns ( ) [protected]

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

Member Function Documentation

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

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

Read-only access to required columns.

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 209 of file MSObsColumns.h.

References flagRow().

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

Read-write access to required columns.

Definition at line 192 of file MSObsColumns.h.

References flagRow_p.

Referenced by flagRow().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 211 of file MSObsColumns.h.

References log().

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

Definition at line 193 of file MSObsColumns.h.

References log_p.

Referenced by log().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 213 of file MSObsColumns.h.

References observer().

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

Definition at line 194 of file MSObsColumns.h.

References observer_p.

Referenced by observer().

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

Reimplemented from casacore::ROMSObservationColumns.

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 215 of file MSObsColumns.h.

References project().

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

Definition at line 195 of file MSObsColumns.h.

References project_p.

Referenced by project().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 217 of file MSObsColumns.h.

References releaseDate().

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

Definition at line 196 of file MSObsColumns.h.

References releaseDate_p.

Referenced by releaseDate().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 221 of file MSObsColumns.h.

References releaseDateMeas().

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

Definition at line 198 of file MSObsColumns.h.

References releaseDateMeas_p.

Referenced by releaseDateMeas().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 219 of file MSObsColumns.h.

References releaseDateQuant().

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

Definition at line 197 of file MSObsColumns.h.

References releaseDateQuant_p.

Referenced by releaseDateQuant().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 223 of file MSObsColumns.h.

References schedule().

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

Definition at line 199 of file MSObsColumns.h.

References schedule_p.

Referenced by schedule().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 225 of file MSObsColumns.h.

References scheduleType().

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

Definition at line 200 of file MSObsColumns.h.

References scheduleType_p.

Referenced by scheduleType().

void casacore::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;

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 227 of file MSObsColumns.h.

References telescopeName().

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

Definition at line 201 of file MSObsColumns.h.

References telescopeName_p.

Referenced by telescopeName().

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

Reimplemented from casacore::ROMSObservationColumns.

Definition at line 229 of file MSObsColumns.h.

References timeRange().