casacore::MSFeedColumns Class Reference

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

#include <MSFeedColumns.h>

Inheritance diagram for casacore::MSFeedColumns:

Public Member Functions
	MSFeedColumns (MSFeed &msFeed)
	Create a columns object that accesses the data in the specified Table.
	~MSFeedColumns ()
	The desctructor does nothing special.
ScalarColumn< Int > &	antennaId ()
	Read-write access to required columns.
ScalarColumn< Int > &	beamId ()
ArrayColumn< Double > &	beamOffset ()
ArrayQuantColumn< Double > &	beamOffsetQuant ()
ArrayMeasColumn< MDirection > &	beamOffsetMeas ()
ScalarColumn< Int > &	feedId ()
ScalarColumn< Double > &	interval ()
ScalarQuantColumn< Double > &	intervalQuant ()
ScalarColumn< Int > &	numReceptors ()
ArrayColumn< Complex > &	polResponse ()
ArrayColumn< String > &	polarizationType ()
ArrayColumn< Double > &	position ()
ArrayQuantColumn< Double > &	positionQuant ()
ScalarMeasColumn< MPosition > &	positionMeas ()
ArrayColumn< Double > &	receptorAngle ()
ArrayQuantColumn< Double > &	receptorAngleQuant ()
ScalarColumn< Int > &	spectralWindowId ()
ScalarColumn< Double > &	time ()
ScalarQuantColumn< Double > &	timeQuant ()
ScalarMeasColumn< MEpoch > &	timeMeas ()
ScalarColumn< Double > &	focusLength ()
	Read-write access to optional columns.
ScalarQuantColumn< Double > &	focusLengthQuant ()
ScalarColumn< Int > &	phasedFeedId ()
const ROScalarColumn< Int > &	antennaId () const
	Read-only access to required columns.
const ROScalarColumn< Int > &	beamId () const
const ROArrayColumn< Double > &	beamOffset () const
const ROArrayQuantColumn < Double > &	beamOffsetQuant () const
const ROArrayMeasColumn < MDirection > &	beamOffsetMeas () const
const ROScalarColumn< Int > &	feedId () const
const ROScalarColumn< Double > &	interval () const
const ROScalarQuantColumn < Double > &	intervalQuant () const
const ROScalarColumn< Int > &	numReceptors () const
const ROArrayColumn< Complex > &	polResponse () const
const ROArrayColumn< String > &	polarizationType () const
const ROArrayColumn< Double > &	position () const
const ROArrayQuantColumn < Double > &	positionQuant () const
const ROScalarMeasColumn < MPosition > &	positionMeas () const
const ROArrayColumn< Double > &	receptorAngle () const
const ROArrayQuantColumn < Double > &	receptorAngleQuant () const
const ROScalarColumn< Int > &	spectralWindowId () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn < Double > &	timeQuant () const
const ROScalarMeasColumn < MEpoch > &	timeMeas () const
const ROScalarColumn< Double > &	focusLength () const
	Read-only access to optional columns.
const ROScalarQuantColumn < Double > &	focusLengthQuant () const
const ROScalarColumn< Int > &	phasedFeedId () const
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch type for the TIME column.
void	setDirectionRef (MDirection::Types ref)
	set the direction type for the BEAM_OFFSET column.
void	setPositionRef (MPosition::Types ref)
	set the position type for the POSITION column.
Protected Member Functions
	MSFeedColumns ()
void	attach (MSFeed &msFeed)
Private Member Functions
	MSFeedColumns (const MSFeedColumns &)
MSFeedColumns &	operator= (const MSFeedColumns &)
void	attachOptionalCols (MSFeed &msFeed)
Private Attributes
ScalarColumn< Int >	antennaId_p
ScalarColumn< Int >	beamId_p
ArrayColumn< Double >	beamOffset_p
ScalarColumn< Int >	feedId_p
ScalarColumn< Double >	interval_p
ScalarColumn< Int >	numReceptors_p
ArrayColumn< Complex >	polResponse_p
ArrayColumn< String >	polarizationType_p
ArrayColumn< Double >	position_p
ArrayColumn< Double >	receptorAngle_p
ScalarColumn< Int >	spectralWindowId_p
ScalarColumn< Double >	time_p
ScalarColumn< Double >	focusLength_p
ScalarColumn< Int >	phasedFeedId_p
ArrayMeasColumn< MDirection >	beamOffsetMeas_p
	Access to Measure columns.
ScalarMeasColumn< MPosition >	positionMeas_p
ScalarMeasColumn< MEpoch >	timeMeas_p
ArrayQuantColumn< Double >	beamOffsetQuant_p
	Access to Quantum columns.
ScalarQuantColumn< Double >	intervalQuant_p
ArrayQuantColumn< Double >	positionQuant_p
ArrayQuantColumn< Double >	receptorAngleQuant_p
ScalarQuantColumn< Double >	timeQuant_p
ScalarQuantColumn< Double >	focusLengthQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSFeedColumns stands for MeasurementSet Feed Table columns.

Synopsis

This class provides access to the columns in the MSFeed 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 245 of file MSFeedColumns.h.

Constructor & Destructor Documentation

casacore::MSFeedColumns::MSFeedColumns ( MSFeed & msFeed )

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

casacore::MSFeedColumns::~MSFeedColumns ( )

The desctructor does nothing special.

casacore::MSFeedColumns::MSFeedColumns ( ) [protected]

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

Member Function Documentation

const ROScalarColumn<Int>& casacore::MSFeedColumns::antennaId ( ) const [inline]

Read-only access to required columns.

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 290 of file MSFeedColumns.h.

References antennaId().

ScalarColumn<Int>& casacore::MSFeedColumns::antennaId ( ) [inline]

Read-write access to required columns.

Definition at line 256 of file MSFeedColumns.h.

References antennaId_p.

Referenced by antennaId().

void casacore::MSFeedColumns::attach ( MSFeed & msFeed ) [protected]

void casacore::MSFeedColumns::attachOptionalCols ( MSFeed & msFeed ) [private]

const ROScalarColumn<Int>& casacore::MSFeedColumns::beamId ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 292 of file MSFeedColumns.h.

References beamId().

ScalarColumn<Int>& casacore::MSFeedColumns::beamId ( ) [inline]

Definition at line 257 of file MSFeedColumns.h.

References beamId_p.

Referenced by beamId().

const ROArrayColumn<Double>& casacore::MSFeedColumns::beamOffset ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 294 of file MSFeedColumns.h.

References beamOffset().

ArrayColumn<Double>& casacore::MSFeedColumns::beamOffset ( ) [inline]

Definition at line 258 of file MSFeedColumns.h.

References beamOffset_p.

Referenced by beamOffset().

const ROArrayMeasColumn<MDirection>& casacore::MSFeedColumns::beamOffsetMeas ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 298 of file MSFeedColumns.h.

References beamOffsetMeas().

ArrayMeasColumn<MDirection>& casacore::MSFeedColumns::beamOffsetMeas ( ) [inline]

Definition at line 260 of file MSFeedColumns.h.

References beamOffsetMeas_p.

Referenced by beamOffsetMeas().

const ROArrayQuantColumn<Double>& casacore::MSFeedColumns::beamOffsetQuant ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 296 of file MSFeedColumns.h.

References beamOffsetQuant().

ArrayQuantColumn<Double>& casacore::MSFeedColumns::beamOffsetQuant ( ) [inline]

Definition at line 259 of file MSFeedColumns.h.

References beamOffsetQuant_p.

Referenced by beamOffsetQuant().

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

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 300 of file MSFeedColumns.h.

References feedId().

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

Definition at line 262 of file MSFeedColumns.h.

References feedId_p.

Referenced by feedId().

const ROScalarColumn<Double>& casacore::MSFeedColumns::focusLength ( ) const [inline]

Read-only access to optional columns.

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 334 of file MSFeedColumns.h.

References focusLength().

ScalarColumn<Double>& casacore::MSFeedColumns::focusLength ( ) [inline]

Read-write access to optional columns.

Definition at line 283 of file MSFeedColumns.h.

References focusLength_p.

Referenced by focusLength().

const ROScalarQuantColumn<Double>& casacore::MSFeedColumns::focusLengthQuant ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 336 of file MSFeedColumns.h.

References focusLengthQuant().

ScalarQuantColumn<Double>& casacore::MSFeedColumns::focusLengthQuant ( ) [inline]

Definition at line 284 of file MSFeedColumns.h.

References focusLengthQuant_p.

Referenced by focusLengthQuant().

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

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 302 of file MSFeedColumns.h.

References interval().

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

Definition at line 263 of file MSFeedColumns.h.

References interval_p.

Referenced by interval().

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

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 304 of file MSFeedColumns.h.

References intervalQuant().

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

Definition at line 264 of file MSFeedColumns.h.

References intervalQuant_p.

Referenced by intervalQuant().

const ROScalarColumn<Int>& casacore::MSFeedColumns::numReceptors ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 306 of file MSFeedColumns.h.

References numReceptors().

ScalarColumn<Int>& casacore::MSFeedColumns::numReceptors ( ) [inline]

Definition at line 265 of file MSFeedColumns.h.

References numReceptors_p.

Referenced by numReceptors().

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

Reimplemented from casacore::ROMSFeedColumns.

const ROScalarColumn<Int>& casacore::MSFeedColumns::phasedFeedId ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 338 of file MSFeedColumns.h.

References phasedFeedId().

ScalarColumn<Int>& casacore::MSFeedColumns::phasedFeedId ( ) [inline]

Definition at line 285 of file MSFeedColumns.h.

References phasedFeedId_p.

Referenced by phasedFeedId().

const ROArrayColumn<String>& casacore::MSFeedColumns::polarizationType ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 310 of file MSFeedColumns.h.

References polarizationType().

ArrayColumn<String>& casacore::MSFeedColumns::polarizationType ( ) [inline]

Definition at line 267 of file MSFeedColumns.h.

References polarizationType_p.

Referenced by polarizationType().

const ROArrayColumn<Complex>& casacore::MSFeedColumns::polResponse ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 308 of file MSFeedColumns.h.

References polResponse().

ArrayColumn<Complex>& casacore::MSFeedColumns::polResponse ( ) [inline]

Definition at line 266 of file MSFeedColumns.h.

References polResponse_p.

Referenced by polResponse().

const ROArrayColumn<Double>& casacore::MSFeedColumns::position ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 312 of file MSFeedColumns.h.

References position().

ArrayColumn<Double>& casacore::MSFeedColumns::position ( ) [inline]

Definition at line 268 of file MSFeedColumns.h.

References position_p.

Referenced by position().

const ROScalarMeasColumn<MPosition>& casacore::MSFeedColumns::positionMeas ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 316 of file MSFeedColumns.h.

References positionMeas().

ScalarMeasColumn<MPosition>& casacore::MSFeedColumns::positionMeas ( ) [inline]

Definition at line 270 of file MSFeedColumns.h.

References positionMeas_p.

Referenced by positionMeas().

const ROArrayQuantColumn<Double>& casacore::MSFeedColumns::positionQuant ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 314 of file MSFeedColumns.h.

References positionQuant().

ArrayQuantColumn<Double>& casacore::MSFeedColumns::positionQuant ( ) [inline]

Definition at line 269 of file MSFeedColumns.h.

References positionQuant_p.

Referenced by positionQuant().

const ROArrayColumn<Double>& casacore::MSFeedColumns::receptorAngle ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 318 of file MSFeedColumns.h.

References receptorAngle().

ArrayColumn<Double>& casacore::MSFeedColumns::receptorAngle ( ) [inline]

Definition at line 272 of file MSFeedColumns.h.

References receptorAngle_p.

Referenced by receptorAngle().

const ROArrayQuantColumn<Double>& casacore::MSFeedColumns::receptorAngleQuant ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 320 of file MSFeedColumns.h.

References receptorAngleQuant().

ArrayQuantColumn<Double>& casacore::MSFeedColumns::receptorAngleQuant ( ) [inline]

Definition at line 273 of file MSFeedColumns.h.

References receptorAngleQuant_p.

Referenced by receptorAngleQuant().

void casacore::MSFeedColumns::setDirectionRef ( MDirection::Types ref )

set the direction type for the BEAM_OFFSET column.

This can only be done when the table has no rows. Trying to do so at other times will throw an exception.

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

void casacore::MSFeedColumns::setPositionRef ( MPosition::Types ref )

set the position type for the POSITION column.

This can only be done when the table has no rows. Trying to do so at other times will throw an exception.

const ROScalarColumn<Int>& casacore::MSFeedColumns::spectralWindowId ( ) const [inline]

Reimplemented from casacore::ROMSFeedColumns.

Definition at line 322 of file MSFeedColumns.h.

References spectralWindowId().

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

Definition at line 275 of file MSFeedColumns.h.

References spectralWindowId_p.

Referenced by spectralWindowId().

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