casacore::MSFreqOffsetColumns Class Reference

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

#include <MSFreqOffColumns.h>

Inheritance diagram for casacore::MSFreqOffsetColumns:

Public Member Functions
	MSFreqOffsetColumns (MSFreqOffset &msFreqOffset)
	Create a columns object that accesses the data in the specified Table.
	~MSFreqOffsetColumns ()
	The destructor does nothing special.
ScalarColumn< Int > &	antenna1 ()
	Read-write access to required columns.
ScalarColumn< Int > &	antenna2 ()
ScalarColumn< Int > &	feedId ()
ScalarColumn< Double > &	interval ()
ScalarQuantColumn< Double > &	intervalQuant ()
ScalarColumn< Double > &	offset ()
ScalarQuantColumn< Double > &	offsetQuant ()
ScalarColumn< Int > &	spectralWindowId ()
ScalarColumn< Double > &	time ()
ScalarQuantColumn< Double > &	timeQuant ()
ScalarMeasColumn< MEpoch > &	timeMeas ()
const ROScalarColumn< Int > &	antenna1 () const
	Read-only access to required columns.
const ROScalarColumn< Int > &	antenna2 () const
const ROScalarColumn< Int > &	feedId () const
const ROScalarColumn< Double > &	interval () const
const ROScalarQuantColumn < Double > &	intervalQuant () const
const ROScalarColumn< Double > &	offset () const
const ROScalarQuantColumn < Double > &	offsetQuant () const
const ROScalarColumn< Int > &	spectralWindowId () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn < Double > &	timeQuant () const
const ROScalarMeasColumn < MEpoch > &	timeMeas () const
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch type for the TIME column.
Protected Member Functions
	MSFreqOffsetColumns ()
void	attach (MSFreqOffset &msFreqOffset)
Private Member Functions
	MSFreqOffsetColumns (const MSFreqOffsetColumns &)
MSFreqOffsetColumns &	operator= (const MSFreqOffsetColumns &)
Private Attributes
ScalarColumn< Int >	antenna1_p
ScalarColumn< Int >	antenna2_p
ScalarColumn< Int >	feedId_p
ScalarColumn< Double >	interval_p
ScalarColumn< Double >	offset_p
ScalarColumn< Int >	spectralWindowId_p
ScalarColumn< Double >	time_p
ScalarMeasColumn< MEpoch >	timeMeas_p
ScalarQuantColumn< Double >	intervalQuant_p
ScalarQuantColumn< Double >	offsetQuant_p
ScalarQuantColumn< Double >	timeQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSFreqOffsetColumns stands for MeasurementSet FreqOffset Table columns.

Synopsis

This class provides access to the columns in the MSFreqOffset 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 179 of file MSFreqOffColumns.h.

Constructor & Destructor Documentation

casacore::MSFreqOffsetColumns::MSFreqOffsetColumns ( MSFreqOffset & msFreqOffset )

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

casacore::MSFreqOffsetColumns::~MSFreqOffsetColumns ( )

The destructor does nothing special.

casacore::MSFreqOffsetColumns::MSFreqOffsetColumns ( ) [protected]

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

Member Function Documentation

const ROScalarColumn<Int>& casacore::MSFreqOffsetColumns::antenna1 ( ) const [inline]

Read-only access to required columns.

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 205 of file MSFreqOffColumns.h.

References antenna1().

ScalarColumn<Int>& casacore::MSFreqOffsetColumns::antenna1 ( ) [inline]

Read-write access to required columns.

Definition at line 190 of file MSFreqOffColumns.h.

References antenna1_p.

Referenced by antenna1().

const ROScalarColumn<Int>& casacore::MSFreqOffsetColumns::antenna2 ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 207 of file MSFreqOffColumns.h.

References antenna2().

ScalarColumn<Int>& casacore::MSFreqOffsetColumns::antenna2 ( ) [inline]

Definition at line 191 of file MSFreqOffColumns.h.

References antenna2_p.

Referenced by antenna2().

void casacore::MSFreqOffsetColumns::attach ( MSFreqOffset & msFreqOffset ) [protected]

const ROScalarColumn<Int>& casacore::MSFreqOffsetColumns::feedId ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 209 of file MSFreqOffColumns.h.

References feedId().

ScalarColumn<Int>& casacore::MSFreqOffsetColumns::feedId ( ) [inline]

Definition at line 192 of file MSFreqOffColumns.h.

References feedId_p.

Referenced by feedId().

const ROScalarColumn<Double>& casacore::MSFreqOffsetColumns::interval ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 211 of file MSFreqOffColumns.h.

References interval().

ScalarColumn<Double>& casacore::MSFreqOffsetColumns::interval ( ) [inline]

Definition at line 193 of file MSFreqOffColumns.h.

References interval_p.

Referenced by interval().

const ROScalarQuantColumn<Double>& casacore::MSFreqOffsetColumns::intervalQuant ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 213 of file MSFreqOffColumns.h.

References intervalQuant().

ScalarQuantColumn<Double>& casacore::MSFreqOffsetColumns::intervalQuant ( ) [inline]

Definition at line 194 of file MSFreqOffColumns.h.

References intervalQuant_p.

Referenced by intervalQuant().

const ROScalarColumn<Double>& casacore::MSFreqOffsetColumns::offset ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 215 of file MSFreqOffColumns.h.

References offset().

ScalarColumn<Double>& casacore::MSFreqOffsetColumns::offset ( ) [inline]

Definition at line 195 of file MSFreqOffColumns.h.

References offset_p.

Referenced by offset().

const ROScalarQuantColumn<Double>& casacore::MSFreqOffsetColumns::offsetQuant ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 217 of file MSFreqOffColumns.h.

References offsetQuant().

ScalarQuantColumn<Double>& casacore::MSFreqOffsetColumns::offsetQuant ( ) [inline]

Definition at line 196 of file MSFreqOffColumns.h.

References offsetQuant_p.

Referenced by offsetQuant().

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

Reimplemented from casacore::ROMSFreqOffsetColumns.

void casacore::MSFreqOffsetColumns::setEpochRef	(	MEpoch::Types	ref,
		Bool	tableMustBeEmpty = `True`
	)

set the epoch type for the TIME column.

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<Int>& casacore::MSFreqOffsetColumns::spectralWindowId ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 219 of file MSFreqOffColumns.h.

References spectralWindowId().

ScalarColumn<Int>& casacore::MSFreqOffsetColumns::spectralWindowId ( ) [inline]

Definition at line 197 of file MSFreqOffColumns.h.

References spectralWindowId_p.

Referenced by spectralWindowId().

const ROScalarColumn<Double>& casacore::MSFreqOffsetColumns::time ( ) const [inline]

Reimplemented from casacore::ROMSFreqOffsetColumns.

Definition at line 221 of file MSFreqOffColumns.h.

References time().