casacore::MSFieldColumns Class Reference

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

#include <MSFieldColumns.h>

Inheritance diagram for casacore::MSFieldColumns:

Public Member Functions
	MSFieldColumns (MSField &msField)
	Construct from the supplied Table.
	~MSFieldColumns ()
	The desctructor does nothing special.
ScalarColumn< String > &	code ()
	Read-write access to required columns.
ArrayColumn< Double > &	delayDir ()
ArrayMeasColumn< MDirection > &	delayDirMeasCol ()
ScalarColumn< Bool > &	flagRow ()
ScalarColumn< String > &	name ()
ScalarColumn< Int > &	numPoly ()
ArrayColumn< Double > &	phaseDir ()
ArrayMeasColumn< MDirection > &	phaseDirMeasCol ()
ArrayColumn< Double > &	referenceDir ()
ArrayMeasColumn< MDirection > &	referenceDirMeasCol ()
ScalarColumn< Int > &	sourceId ()
ScalarColumn< Double > &	time ()
ScalarQuantColumn< Double > &	timeQuant ()
ScalarMeasColumn< MEpoch > &	timeMeas ()
ScalarColumn< Int > &	ephemerisId ()
	Read-write access to optional columns.
const ROScalarColumn< String > &	code () const
	Read-only access to required columns.
const ROArrayColumn< Double > &	delayDir () const
const ROArrayMeasColumn < MDirection > &	delayDirMeasCol () const
const ROScalarColumn< Bool > &	flagRow () const
const ROScalarColumn< String > &	name () const
const ROScalarColumn< Int > &	numPoly () const
const ROArrayColumn< Double > &	phaseDir () const
const ROArrayMeasColumn < MDirection > &	phaseDirMeasCol () const
const ROArrayColumn< Double > &	referenceDir () const
const ROArrayMeasColumn < MDirection > &	referenceDirMeasCol () const
const ROScalarColumn< Int > &	sourceId () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn < Double > &	timeQuant () const
const ROScalarMeasColumn < MEpoch > &	timeMeas () const
const ROScalarColumn< Int > &	ephemerisId () const
	Read-only access to optional columns.
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch reference type for the TIME column.
void	setDirectionRef (MDirection::Types ref)
	set the direction reference type for the REFERENCE_DIR, DELAY_DIR & PHASE_DIR columns.
Static Public Member Functions
static MDirection	interpolateDirMeas (const Array< MDirection > &arrDir, Int numPoly, Double interTime, Double timeOrigin)
	Interpolate the direction Measure polynomial.
Protected Member Functions
	MSFieldColumns ()
void	attach (MSField &msField)
Private Member Functions
	MSFieldColumns (const MSFieldColumns &)
MSFieldColumns &	operator= (const MSFieldColumns &)
void	attachOptionalCols (MSField &msField)
Private Attributes
ScalarColumn< String >	name_p
ScalarColumn< String >	code_p
ScalarColumn< Double >	time_p
ScalarColumn< Int >	numPoly_p
ArrayColumn< Double >	delayDir_p
ArrayColumn< Double >	phaseDir_p
ArrayColumn< Double >	referenceDir_p
ScalarColumn< Int >	sourceId_p
ScalarColumn< Bool >	flagRow_p
ScalarColumn< Int >	ephemerisId_p
ScalarMeasColumn< MEpoch >	timeMeas_p
ArrayMeasColumn< MDirection >	delayDirMeas_p
ArrayMeasColumn< MDirection >	phaseDirMeas_p
ArrayMeasColumn< MDirection >	referenceDirMeas_p
ScalarQuantColumn< Double >	timeQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSFieldColumns stands for MeasurementSet Field Table columns.

Synopsis

This class provides access to the columns in the MSField 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 275 of file MSFieldColumns.h.

Constructor & Destructor Documentation

casacore::MSFieldColumns::MSFieldColumns ( MSField & msField )

Construct from the supplied Table.

casacore::MSFieldColumns::~MSFieldColumns ( )

The desctructor does nothing special.

casacore::MSFieldColumns::MSFieldColumns ( ) [protected]

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

Member Function Documentation

void casacore::MSFieldColumns::attach ( MSField & msField ) [protected]

void casacore::MSFieldColumns::attachOptionalCols ( MSField & msField ) [private]

const ROScalarColumn<String>& casacore::MSFieldColumns::code ( ) const [inline]

Read-only access to required columns.

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 317 of file MSFieldColumns.h.

References code().

ScalarColumn<String>& casacore::MSFieldColumns::code ( ) [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 ROMSFieldColumns class.

Definition at line 291 of file MSFieldColumns.h.

References code_p.

Referenced by code().

const ROArrayColumn<Double>& casacore::MSFieldColumns::delayDir ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 319 of file MSFieldColumns.h.

References delayDir().

ArrayColumn<Double>& casacore::MSFieldColumns::delayDir ( ) [inline]

Definition at line 292 of file MSFieldColumns.h.

References delayDir_p.

Referenced by delayDir().

const ROArrayMeasColumn<MDirection>& casacore::MSFieldColumns::delayDirMeasCol ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 321 of file MSFieldColumns.h.

References delayDirMeasCol().

ArrayMeasColumn<MDirection>& casacore::MSFieldColumns::delayDirMeasCol ( ) [inline]

Definition at line 293 of file MSFieldColumns.h.

References delayDirMeas_p.

Referenced by delayDirMeasCol().

const ROScalarColumn<Int>& casacore::MSFieldColumns::ephemerisId ( ) const [inline]

Read-only access to optional columns.

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 349 of file MSFieldColumns.h.

References ephemerisId().

ScalarColumn<Int>& casacore::MSFieldColumns::ephemerisId ( ) [inline]

Read-write access to optional columns.

Definition at line 312 of file MSFieldColumns.h.

References ephemerisId_p.

Referenced by ephemerisId().

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

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 323 of file MSFieldColumns.h.

References flagRow().

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

Definition at line 295 of file MSFieldColumns.h.

References flagRow_p.

Referenced by flagRow().

static MDirection casacore::MSFieldColumns::interpolateDirMeas	(	const Array< MDirection > &	arrDir,
		Int	numPoly,
		Double	interTime,
		Double	timeOrigin
	)			`[static]`

Interpolate the direction Measure polynomial.

const ROScalarColumn<String>& casacore::MSFieldColumns::name ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 325 of file MSFieldColumns.h.

References name().

ScalarColumn<String>& casacore::MSFieldColumns::name ( ) [inline]

Definition at line 296 of file MSFieldColumns.h.

References name_p.

Referenced by name().

const ROScalarColumn<Int>& casacore::MSFieldColumns::numPoly ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 327 of file MSFieldColumns.h.

References numPoly().

ScalarColumn<Int>& casacore::MSFieldColumns::numPoly ( ) [inline]

Definition at line 297 of file MSFieldColumns.h.

References numPoly_p.

Referenced by numPoly().

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

Reimplemented from casacore::ROMSFieldColumns.

const ROArrayColumn<Double>& casacore::MSFieldColumns::phaseDir ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 329 of file MSFieldColumns.h.

References phaseDir().

ArrayColumn<Double>& casacore::MSFieldColumns::phaseDir ( ) [inline]

Definition at line 298 of file MSFieldColumns.h.

References phaseDir_p.

Referenced by phaseDir().

const ROArrayMeasColumn<MDirection>& casacore::MSFieldColumns::phaseDirMeasCol ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 331 of file MSFieldColumns.h.

References phaseDirMeasCol().

ArrayMeasColumn<MDirection>& casacore::MSFieldColumns::phaseDirMeasCol ( ) [inline]

Definition at line 299 of file MSFieldColumns.h.

References phaseDirMeas_p.

Referenced by phaseDirMeasCol().

const ROArrayColumn<Double>& casacore::MSFieldColumns::referenceDir ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 333 of file MSFieldColumns.h.

References referenceDir().

ArrayColumn<Double>& casacore::MSFieldColumns::referenceDir ( ) [inline]

Definition at line 301 of file MSFieldColumns.h.

References referenceDir_p.

Referenced by referenceDir().

const ROArrayMeasColumn<MDirection>& casacore::MSFieldColumns::referenceDirMeasCol ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 335 of file MSFieldColumns.h.

References referenceDirMeasCol().

ArrayMeasColumn<MDirection>& casacore::MSFieldColumns::referenceDirMeasCol ( ) [inline]

Definition at line 302 of file MSFieldColumns.h.

References referenceDirMeas_p.

Referenced by referenceDirMeasCol().

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

set the direction reference type for the REFERENCE_DIR, DELAY_DIR & PHASE_DIR columns.

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

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

set the epoch reference 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::MSFieldColumns::sourceId ( ) const [inline]

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 337 of file MSFieldColumns.h.

References sourceId().

ScalarColumn<Int>& casacore::MSFieldColumns::sourceId ( ) [inline]

Definition at line 304 of file MSFieldColumns.h.

References sourceId_p.

Referenced by sourceId().

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

Reimplemented from casacore::ROMSFieldColumns.

Definition at line 339 of file MSFieldColumns.h.

References time().