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

#include <MSPointingColumns.h>

Inheritance diagram for casa::MSPointingColumns:

Public Member Functions
	MSPointingColumns (MSPointing &msPointing)
	Construct from the supplied Table.
	~MSPointingColumns ()
	The destructor does nothing special.
ScalarColumn< Int > &	antennaId ()
	Read-write access to required columns.
ScalarColumn< Double > &	time ()
ScalarMeasColumn< MEpoch > &	timeMeas ()
ScalarQuantColumn< Double > &	timeQuant ()
ScalarColumn< Double > &	interval ()
ScalarQuantColumn< Double > &	intervalQuant ()
ScalarColumn< String > &	name ()
ScalarColumn< Int > &	numPoly ()
ScalarColumn< Double > &	timeOrigin ()
ScalarQuantColumn< Double > &	timeOriginQuant ()
ScalarMeasColumn< MEpoch > &	timeOriginMeas ()
ArrayColumn< Double > &	direction ()
ArrayMeasColumn< MDirection > &	directionMeasCol ()
ArrayColumn< Double > &	target ()
ArrayMeasColumn< MDirection > &	targetMeasCol ()
ScalarColumn< Bool > &	tracking ()
ArrayColumn< Double > &	pointingOffset ()
	Read-write access to optional columns.
ArrayMeasColumn< MDirection > &	pointingOffsetMeasCol ()
ArrayColumn< Double > &	sourceOffset ()
ArrayMeasColumn< MDirection > &	sourceOffsetMeasCol ()
ArrayColumn< Double > &	encoder ()
ScalarMeasColumn< MDirection > &	encoderMeas ()
ScalarColumn< Int > &	pointingModelId ()
ScalarColumn< Bool > &	onSource ()
ScalarColumn< Bool > &	overTheTop ()
const ROScalarColumn< Int > &	antennaId () const
	Read-only access to required columns.
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn < Double > &	timeQuant () const
const ROScalarMeasColumn < MEpoch > &	timeMeas () const
const ROScalarColumn< Double > &	interval () const
const ROScalarQuantColumn < Double > &	intervalQuant () const
const ROScalarColumn< String > &	name () const
const ROScalarColumn< Int > &	numPoly () const
const ROScalarColumn< Double > &	timeOrigin () const
const ROScalarQuantColumn < Double > &	timeOriginQuant () const
const ROScalarMeasColumn < MEpoch > &	timeOriginMeas () const
const ROArrayColumn< Double > &	direction () const
const ROArrayMeasColumn < MDirection > &	directionMeasCol () const
const ROArrayColumn< Double > &	target () const
const ROArrayMeasColumn < MDirection > &	targetMeasCol () const
const ROScalarColumn< Bool > &	tracking () const
const ROArrayColumn< Double > &	pointingOffset () const
	Access to optional columns.
const ROArrayMeasColumn < MDirection > &	pointingOffsetMeasCol () const
const ROArrayColumn< Double > &	sourceOffset () const
const ROArrayMeasColumn < MDirection > &	sourceOffsetMeasCol () const
const ROArrayColumn< Double > &	encoder () const
const ROScalarMeasColumn < MDirection > &	encoderMeas () const
const ROScalarColumn< Int > &	pointingModelId () const
const ROScalarColumn< Bool > &	onSource () const
const ROScalarColumn< Bool > &	overTheTop () const
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch reference type for the TIME & TIME_ORIGIN column.
void	setDirectionRef (MDirection::Types ref)
	set the direction reference type for the DIRECTION, TARGET & and, if defined, the SOURCE_OFFSET & POINTING_OFFSET columns.
void	setEncoderDirectionRef (MDirection::Types ref)
	set the direction reference type for the ENCODER column (if it is defined).
Protected Member Functions
	MSPointingColumns ()
void	attach (MSPointing &msPointing)
Private Member Functions
	MSPointingColumns (const MSPointingColumns &)
MSPointingColumns &	operator= (const MSPointingColumns &)
void	attachOptionalCols (MSPointing &msPointing)
Private Attributes
ScalarColumn< Int >	antennaId_p
ArrayColumn< Double >	direction_p
ScalarColumn< Double >	interval_p
ScalarColumn< String >	name_p
ScalarColumn< Int >	numPoly_p
ArrayColumn< Double >	target_p
ScalarColumn< Double >	time_p
ScalarColumn< Double >	timeOrigin_p
ScalarColumn< Bool >	tracking_p
ArrayColumn< Double >	encoder_p
ScalarColumn< Bool >	onSource_p
ScalarColumn< Int >	pointingModelId_p
ArrayColumn< Double >	pointingOffset_p
ArrayColumn< Double >	sourceOffset_p
ScalarColumn< Bool >	overTheTop_p
ArrayMeasColumn< MDirection >	directionMeas_p
ArrayMeasColumn< MDirection >	targetMeas_p
ScalarMeasColumn< MEpoch >	timeMeas_p
ScalarMeasColumn< MEpoch >	timeOriginMeas_p
ScalarMeasColumn< MDirection >	encoderMeas_p
ArrayMeasColumn< MDirection >	pointingOffsetMeas_p
ArrayMeasColumn< MDirection >	sourceOffsetMeas_p
ScalarQuantColumn< Double >	intervalQuant_p
ScalarQuantColumn< Double >	timeQuant_p
ScalarQuantColumn< Double >	timeOriginQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSPointingColumns stands for MeasurementSet Pointing Table columns.

Synopsis

This class provides access to the columns in the MSPointing 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 233 of file MSPointingColumns.h.

Constructor & Destructor Documentation

casa::MSPointingColumns::MSPointingColumns ( MSPointing & msPointing )

Construct from the supplied Table.

casa::MSPointingColumns::~MSPointingColumns ( )

The destructor does nothing special.

casa::MSPointingColumns::MSPointingColumns ( ) [protected]

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

Member Function Documentation

ScalarColumn<Int>& casa::MSPointingColumns::antennaId ( ) [inline]

Read-write access to required columns.

Note that the direction measures with a stored polynomial have Col() added to their name. They are better accessed via the functions that have the same name, without the Col suffix, that will do the interpolation for you. These functions are in the ROMSPointingColumns class.

Definition at line 249 of file MSPointingColumns.h.

References antennaId_p.

Referenced by antennaId().

const ROScalarColumn<Int>& casa::MSPointingColumns::antennaId ( ) const [inline]

Read-only access to required columns.

Reimplemented from casa::ROMSPointingColumns.

Definition at line 289 of file MSPointingColumns.h.

References antennaId().

void casa::MSPointingColumns::attach ( MSPointing & msPointing ) [protected]

void casa::MSPointingColumns::attachOptionalCols ( MSPointing & msPointing ) [private]

ArrayColumn<Double>& casa::MSPointingColumns::direction ( ) [inline]

Definition at line 260 of file MSPointingColumns.h.

References direction_p.

Referenced by direction().

const ROArrayColumn<Double>& casa::MSPointingColumns::direction ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 311 of file MSPointingColumns.h.

References direction().

ArrayMeasColumn<MDirection>& casa::MSPointingColumns::directionMeasCol ( ) [inline]

Definition at line 261 of file MSPointingColumns.h.

References directionMeas_p.

Referenced by directionMeasCol().

const ROArrayMeasColumn<MDirection>& casa::MSPointingColumns::directionMeasCol ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 313 of file MSPointingColumns.h.

References directionMeasCol().

ArrayColumn<Double>& casa::MSPointingColumns::encoder ( ) [inline]

Definition at line 280 of file MSPointingColumns.h.

References encoder_p.

Referenced by encoder().

const ROArrayColumn<Double>& casa::MSPointingColumns::encoder ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 333 of file MSPointingColumns.h.

References encoder().

ScalarMeasColumn<MDirection>& casa::MSPointingColumns::encoderMeas ( ) [inline]

Definition at line 281 of file MSPointingColumns.h.

References encoderMeas_p.

Referenced by encoderMeas().

const ROScalarMeasColumn<MDirection>& casa::MSPointingColumns::encoderMeas ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 335 of file MSPointingColumns.h.

References encoderMeas().

ScalarColumn<Double>& casa::MSPointingColumns::interval ( ) [inline]

Definition at line 253 of file MSPointingColumns.h.

References interval_p.

Referenced by interval().

const ROScalarColumn<Double>& casa::MSPointingColumns::interval ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 297 of file MSPointingColumns.h.

References interval().

ScalarQuantColumn<Double>& casa::MSPointingColumns::intervalQuant ( ) [inline]

Definition at line 254 of file MSPointingColumns.h.

References intervalQuant_p.

Referenced by intervalQuant().

const ROScalarQuantColumn<Double>& casa::MSPointingColumns::intervalQuant ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 299 of file MSPointingColumns.h.

References intervalQuant().

ScalarColumn<String>& casa::MSPointingColumns::name ( ) [inline]

Definition at line 255 of file MSPointingColumns.h.

References name_p.

Referenced by name().

const ROScalarColumn<String>& casa::MSPointingColumns::name ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 301 of file MSPointingColumns.h.

References name().

ScalarColumn<Int>& casa::MSPointingColumns::numPoly ( ) [inline]

Definition at line 256 of file MSPointingColumns.h.

References numPoly_p.

Referenced by numPoly().

const ROScalarColumn<Int>& casa::MSPointingColumns::numPoly ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 303 of file MSPointingColumns.h.

References numPoly().

ScalarColumn<Bool>& casa::MSPointingColumns::onSource ( ) [inline]

Definition at line 283 of file MSPointingColumns.h.

References onSource_p.

Referenced by onSource().

const ROScalarColumn<Bool>& casa::MSPointingColumns::onSource ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 339 of file MSPointingColumns.h.

References onSource().

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

ScalarColumn<Bool>& casa::MSPointingColumns::overTheTop ( ) [inline]

Definition at line 284 of file MSPointingColumns.h.

References overTheTop_p.

Referenced by overTheTop().

const ROScalarColumn<Bool>& casa::MSPointingColumns::overTheTop ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 341 of file MSPointingColumns.h.

References overTheTop().

ScalarColumn<Int>& casa::MSPointingColumns::pointingModelId ( ) [inline]

Definition at line 282 of file MSPointingColumns.h.

References pointingModelId_p.

Referenced by pointingModelId().

const ROScalarColumn<Int>& casa::MSPointingColumns::pointingModelId ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 337 of file MSPointingColumns.h.

References pointingModelId().

ArrayColumn<Double>& casa::MSPointingColumns::pointingOffset ( ) [inline]

Read-write access to optional columns.

Note that the direction measures with a stored polynomial have Col() added to their name. They are better accessed via the functions that have the same name, without the Col suffix, that will do the interpolation for you. These functions are in the ROMSPointingColumns class.

Definition at line 274 of file MSPointingColumns.h.

References pointingOffset_p.

Referenced by pointingOffset().

const ROArrayColumn<Double>& casa::MSPointingColumns::pointingOffset ( ) const [inline]

Access to optional columns.

Reimplemented from casa::ROMSPointingColumns.

Definition at line 325 of file MSPointingColumns.h.

References pointingOffset().

ArrayMeasColumn<MDirection>& casa::MSPointingColumns::pointingOffsetMeasCol ( ) [inline]

Definition at line 275 of file MSPointingColumns.h.

References pointingOffsetMeas_p.

Referenced by pointingOffsetMeasCol().

const ROArrayMeasColumn<MDirection>& casa::MSPointingColumns::pointingOffsetMeasCol ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 327 of file MSPointingColumns.h.

References pointingOffsetMeasCol().

void casa::MSPointingColumns::setDirectionRef ( MDirection::Types ref )

set the direction reference type for the DIRECTION, TARGET & and, if defined, the SOURCE_OFFSET & POINTING_OFFSET columns.

This can only be done when the table has no rows. Trying to do so at other times will throw an exception. Note that the optional ENCODER column must be done separately as the MSv2 definition requires this column to use the frame(s) of the antenna mounts.

void casa::MSPointingColumns::setEncoderDirectionRef ( MDirection::Types ref )

set the direction reference type for the ENCODER column (if it is defined).

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

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

set the epoch reference type for the TIME & TIME_ORIGIN 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;

ArrayColumn<Double>& casa::MSPointingColumns::sourceOffset ( ) [inline]

Definition at line 277 of file MSPointingColumns.h.

References sourceOffset_p.

Referenced by sourceOffset().

const ROArrayColumn<Double>& casa::MSPointingColumns::sourceOffset ( ) const [inline]

Reimplemented from casa::ROMSPointingColumns.

Definition at line 329 of file MSPointingColumns.h.

References sourceOffset().

ArrayMeasColumn<MDirection>& casa::MSPointingColumns::sourceOffsetMeasCol ( ) [inline]

Definition at line 278 of file MSPointingColumns.h.

References sourceOffsetMeas_p.

Referenced by sourceOffsetMeasCol().