casa::MSSourceColumns Class Reference
[MeasurementSets]

#include <MSSourceColumns.h>

Inheritance diagram for casa::MSSourceColumns:

[legend]Collaboration diagram for casa::MSSourceColumns:

[legend]List of all members.

Detailed Description

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

Intended use:

Part of API

Review Status

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

Prerequisite

Etymology

MSSourceColumns stands for MeasurementSet Source Table columns.

Synopsis

This class provides access to the columns in the MSSource 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.

Constructor & Destructor Documentation

casa::MSSourceColumns::MSSourceColumns ( MSSource & msSource )

Construct from the supplied Table.

casa::MSSourceColumns::~MSSourceColumns ( )

The destructor does nothing special.

casa::MSSourceColumns::MSSourceColumns ( ) [protected]

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

Member Function Documentation

ScalarColumn<Int>& casa::MSSourceColumns::calibrationGroup ( ) [inline]

Read-write access to required columns.

Definition at line 249 of file MSSourceColumns.h.

References calibrationGroup_p.

ScalarColumn<String>& casa::MSSourceColumns::code ( ) [inline]

Definition at line 250 of file MSSourceColumns.h.

References code_p.

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

Definition at line 251 of file MSSourceColumns.h.

References direction_p.

ArrayQuantColumn<Double>& casa::MSSourceColumns::directionQuant ( ) [inline]

Definition at line 252 of file MSSourceColumns.h.

References directionQuant_p.

ScalarMeasColumn<MDirection>& casa::MSSourceColumns::directionMeas ( ) [inline]

Definition at line 253 of file MSSourceColumns.h.

References directionMeas_p.

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

Definition at line 254 of file MSSourceColumns.h.

References interval_p.

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

Definition at line 255 of file MSSourceColumns.h.

References intervalQuant_p.

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

Definition at line 256 of file MSSourceColumns.h.

References name_p.

ScalarColumn<Int>& casa::MSSourceColumns::numLines ( ) [inline]

Definition at line 257 of file MSSourceColumns.h.

References numLines_p.

ArrayColumn<Double>& casa::MSSourceColumns::properMotion ( ) [inline]

Definition at line 258 of file MSSourceColumns.h.

References properMotion_p.

ArrayQuantColumn<Double>& casa::MSSourceColumns::properMotionQuant ( ) [inline]

Definition at line 259 of file MSSourceColumns.h.

References properMotionQuant_p.

ScalarColumn<Int>& casa::MSSourceColumns::sourceId ( ) [inline]

Definition at line 260 of file MSSourceColumns.h.

References sourceId_p.

ScalarColumn<Int>& casa::MSSourceColumns::spectralWindowId ( ) [inline]

Definition at line 261 of file MSSourceColumns.h.

References spectralWindowId_p.

ScalarColumn<Double>& casa::MSSourceColumns::time ( ) [inline]

Definition at line 262 of file MSSourceColumns.h.

References time_p.

ScalarQuantColumn<Double>& casa::MSSourceColumns::timeQuant ( ) [inline]

Definition at line 263 of file MSSourceColumns.h.

References timeQuant_p.

ScalarMeasColumn<MEpoch>& casa::MSSourceColumns::timeMeas ( ) [inline]

Definition at line 264 of file MSSourceColumns.h.

References timeMeas_p.

ArrayColumn<Double>& casa::MSSourceColumns::position ( ) [inline]

Read-write access to optional columns.

Definition at line 269 of file MSSourceColumns.h.

References position_p.

ArrayQuantColumn<Double>& casa::MSSourceColumns::positionQuant ( ) [inline]

Definition at line 270 of file MSSourceColumns.h.

References positionQuant_p.

ScalarMeasColumn<MPosition>& casa::MSSourceColumns::positionMeas ( ) [inline]

Definition at line 271 of file MSSourceColumns.h.

References positionMeas_p.

ScalarColumn<Int>& casa::MSSourceColumns::pulsarId ( ) [inline]

Definition at line 272 of file MSSourceColumns.h.

References pulsarId_p.

ArrayColumn<Double>& casa::MSSourceColumns::restFrequency ( ) [inline]

Definition at line 273 of file MSSourceColumns.h.

References restFrequency_p.

ArrayQuantColumn<Double>& casa::MSSourceColumns::restFrequencyQuant ( ) [inline]

Definition at line 274 of file MSSourceColumns.h.

References restFrequencyQuant_p.

ArrayMeasColumn<MFrequency>& casa::MSSourceColumns::restFrequencyMeas ( ) [inline]

Definition at line 275 of file MSSourceColumns.h.

References restFrequencyMeas_p.

ScalarColumn<TableRecord>& casa::MSSourceColumns::sourceModel ( ) [inline]

Definition at line 277 of file MSSourceColumns.h.

References sourceModel_p.

ArrayColumn<Double>& casa::MSSourceColumns::sysvel ( ) [inline]

Definition at line 278 of file MSSourceColumns.h.

References sysvel_p.

ArrayQuantColumn<Double>& casa::MSSourceColumns::sysvelQuant ( ) [inline]

Definition at line 279 of file MSSourceColumns.h.

References sysvelQuant_p.

ArrayMeasColumn<MRadialVelocity>& casa::MSSourceColumns::sysvelMeas ( ) [inline]

Definition at line 280 of file MSSourceColumns.h.

References sysvelMeas_p.

ArrayColumn<String>& casa::MSSourceColumns::transition ( ) [inline]

Definition at line 281 of file MSSourceColumns.h.

References transition_p.

const ROScalarColumn<Int>& casa::MSSourceColumns::calibrationGroup ( ) const [inline]

Read-only access to required columns.

Reimplemented from casa::ROMSSourceColumns.

Definition at line 286 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::calibrationGroup().

const ROScalarColumn<String>& casa::MSSourceColumns::code ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 288 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::code().

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

Reimplemented from casa::ROMSSourceColumns.

Definition at line 290 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::direction().

const ROArrayQuantColumn<Double>& casa::MSSourceColumns::directionQuant ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 292 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::directionQuant().

const ROScalarMeasColumn<MDirection>& casa::MSSourceColumns::directionMeas ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 294 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::directionMeas().

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

Reimplemented from casa::ROMSSourceColumns.

Definition at line 296 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::interval().

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

Reimplemented from casa::ROMSSourceColumns.

Definition at line 298 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::intervalQuant().

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

Reimplemented from casa::ROMSSourceColumns.

Definition at line 300 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::name().

const ROScalarColumn<Int>& casa::MSSourceColumns::numLines ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 302 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::numLines().

const ROArrayColumn<Double>& casa::MSSourceColumns::properMotion ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 304 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::properMotion().

const ROArrayQuantColumn<Double>& casa::MSSourceColumns::properMotionQuant ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 306 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::properMotionQuant().

const ROScalarColumn<Int>& casa::MSSourceColumns::sourceId ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 308 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::sourceId().

const ROScalarColumn<Int>& casa::MSSourceColumns::spectralWindowId ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 310 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::spectralWindowId().

const ROScalarColumn<Double>& casa::MSSourceColumns::time ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 312 of file MSSourceColumns.h.

References casa::time().

const ROScalarQuantColumn<Double>& casa::MSSourceColumns::timeQuant ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 314 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::timeQuant().

const ROScalarMeasColumn<MEpoch>& casa::MSSourceColumns::timeMeas ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 316 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::timeMeas().

const ROArrayColumn<Double>& casa::MSSourceColumns::position ( ) const [inline]

Read-only access to optional columns.

Reimplemented from casa::ROMSSourceColumns.

Definition at line 322 of file MSSourceColumns.h.

References casa::position().

const ROArrayQuantColumn<Double>& casa::MSSourceColumns::positionQuant ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 324 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::positionQuant().

const ROScalarMeasColumn<MPosition>& casa::MSSourceColumns::positionMeas ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 326 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::positionMeas().

const ROScalarColumn<Int>& casa::MSSourceColumns::pulsarId ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 328 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::pulsarId().

const ROArrayColumn<Double>& casa::MSSourceColumns::restFrequency ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 330 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::restFrequency().

const ROArrayQuantColumn<Double>& casa::MSSourceColumns::restFrequencyQuant ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 332 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::restFrequencyQuant().

const ROArrayMeasColumn<MFrequency>& casa::MSSourceColumns::restFrequencyMeas ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 334 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::restFrequencyMeas().

const ROScalarColumn<TableRecord>& casa::MSSourceColumns::sourceModel ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 336 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::sourceModel().

const ROArrayColumn<Double>& casa::MSSourceColumns::sysvel ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 338 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::sysvel().

const ROArrayQuantColumn<Double>& casa::MSSourceColumns::sysvelQuant ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 340 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::sysvelQuant().

const ROArrayMeasColumn<MRadialVelocity>& casa::MSSourceColumns::sysvelMeas ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 342 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::sysvelMeas().

const ROArrayColumn<String>& casa::MSSourceColumns::transition ( ) const [inline]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 344 of file MSSourceColumns.h.

References casa::ROMSSourceColumns::transition().

void casa::MSSourceColumns::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 casa::MSSourceColumns::setDirectionRef ( MDirection::Types ref )

set the direction type for the DIRECTION column.

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

void casa::MSSourceColumns::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.

void casa::MSSourceColumns::setFrequencyRef ( MFrequency::Types ref )

set the frequency type for the REST_FREQUENCY column.

Does nothing if this column is not 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::MSSourceColumns::setRadialVelocityRef ( MRadialVelocity::Types ref )

set the radial velocity type for the SYSVEL column.

Does nothing if this column is not 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::MSSourceColumns::attach ( MSSource & msSource ) [protected]

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

void casa::MSSourceColumns::attachOptionalCols ( MSSource & msSource ) [private]

Member Data Documentation

ScalarColumn<Int> casa::MSSourceColumns::calibrationGroup_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 397 of file MSSourceColumns.h.

Referenced by calibrationGroup().

ScalarColumn<String> casa::MSSourceColumns::code_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 398 of file MSSourceColumns.h.

Referenced by code().

ArrayColumn<Double> casa::MSSourceColumns::direction_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 399 of file MSSourceColumns.h.

Referenced by direction().

ScalarColumn<Double> casa::MSSourceColumns::interval_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 400 of file MSSourceColumns.h.

Referenced by interval().

ScalarColumn<String> casa::MSSourceColumns::name_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 401 of file MSSourceColumns.h.

Referenced by name().

ScalarColumn<Int> casa::MSSourceColumns::numLines_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 402 of file MSSourceColumns.h.

Referenced by numLines().

ArrayColumn<Double> casa::MSSourceColumns::properMotion_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 403 of file MSSourceColumns.h.

Referenced by properMotion().

ScalarColumn<Int> casa::MSSourceColumns::sourceId_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 404 of file MSSourceColumns.h.

Referenced by sourceId().

ScalarColumn<Int> casa::MSSourceColumns::spectralWindowId_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 405 of file MSSourceColumns.h.

Referenced by spectralWindowId().

ScalarColumn<Double> casa::MSSourceColumns::time_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 406 of file MSSourceColumns.h.

Referenced by time().

ArrayColumn<Double> casa::MSSourceColumns::position_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 408 of file MSSourceColumns.h.

Referenced by position().

ScalarColumn<Int> casa::MSSourceColumns::pulsarId_p [private]

Reimplemented from casa::ROMSSourceColumns.

Definition at line 409 of file MSSourceColumns.h.

Referenced by pulsarId().

ArrayColumn<Double> casa::MSSourceColumns::restFrequency_p [private]


Public Member Functions
	MSSourceColumns (MSSource &msSource)
	Construct from the supplied Table.
	~MSSourceColumns ()
	The destructor does nothing special.
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 DIRECTION column.
void	setPositionRef (MPosition::Types ref)
	set the position type for the POSITION column.
void	setFrequencyRef (MFrequency::Types ref)
	set the frequency type for the REST_FREQUENCY column.
void	setRadialVelocityRef (MRadialVelocity::Types ref)
	set the radial velocity type for the SYSVEL column.

ScalarColumn< Int > &	calibrationGroup ()
	Read-write access to required columns.
ScalarColumn< String > &	code ()
ArrayColumn< Double > &	direction ()
ArrayQuantColumn< Double > &	directionQuant ()
ScalarMeasColumn< MDirection > &	directionMeas ()
ScalarColumn< Double > &	interval ()
ScalarQuantColumn< Double > &	intervalQuant ()
ScalarColumn< String > &	name ()
ScalarColumn< Int > &	numLines ()
ArrayColumn< Double > &	properMotion ()
ArrayQuantColumn< Double > &	properMotionQuant ()
ScalarColumn< Int > &	sourceId ()
ScalarColumn< Int > &	spectralWindowId ()
ScalarColumn< Double > &	time ()
ScalarQuantColumn< Double > &	timeQuant ()
ScalarMeasColumn< MEpoch > &	timeMeas ()

ArrayColumn< Double > &	position ()
	Read-write access to optional columns.
ArrayQuantColumn< Double > &	positionQuant ()
ScalarMeasColumn< MPosition > &	positionMeas ()
ScalarColumn< Int > &	pulsarId ()
ArrayColumn< Double > &	restFrequency ()
ArrayQuantColumn< Double > &	restFrequencyQuant ()
ArrayMeasColumn< MFrequency > &	restFrequencyMeas ()
ScalarColumn< TableRecord > &	sourceModel ()
ArrayColumn< Double > &	sysvel ()
ArrayQuantColumn< Double > &	sysvelQuant ()
ArrayMeasColumn< MRadialVelocity > &	sysvelMeas ()
ArrayColumn< String > &	transition ()

const ROScalarColumn< Int > &	calibrationGroup () const
	Read-only access to required columns.
const ROScalarColumn< String > &	code () const
const ROArrayColumn< Double > &	direction () const
const ROArrayQuantColumn< Double > &	directionQuant () const
const ROScalarMeasColumn< MDirection > &	directionMeas () const
const ROScalarColumn< Double > &	interval () const
const ROScalarQuantColumn< Double > &	intervalQuant () const
const ROScalarColumn< String > &	name () const
const ROScalarColumn< Int > &	numLines () const
const ROArrayColumn< Double > &	properMotion () const
const ROArrayQuantColumn< Double > &	properMotionQuant () const
const ROScalarColumn< Int > &	sourceId () const
const ROScalarColumn< Int > &	spectralWindowId () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn< Double > &	timeQuant () const
const ROScalarMeasColumn< MEpoch > &	timeMeas () const

const ROArrayColumn< Double > &	position () const
	Read-only access to optional columns.
const ROArrayQuantColumn< Double > &	positionQuant () const
const ROScalarMeasColumn< MPosition > &	positionMeas () const
const ROScalarColumn< Int > &	pulsarId () const
const ROArrayColumn< Double > &	restFrequency () const
const ROArrayQuantColumn< Double > &	restFrequencyQuant () const
const ROArrayMeasColumn< MFrequency > &	restFrequencyMeas () const
const ROScalarColumn< TableRecord > &	sourceModel () const
const ROArrayColumn< Double > &	sysvel () const
const ROArrayQuantColumn< Double > &	sysvelQuant () const
const ROArrayMeasColumn< MRadialVelocity > &	sysvelMeas () const
const ROArrayColumn< String > &	transition () const
Protected Member Functions
	MSSourceColumns ()
void	attach (MSSource &msSource)
Private Member Functions
	MSSourceColumns (const MSSourceColumns &)
MSSourceColumns &	operator= (const MSSourceColumns &)
void	attachOptionalCols (MSSource &msSource)
Private Attributes
ScalarColumn< Int >	calibrationGroup_p
ScalarColumn< String >	code_p
ArrayColumn< Double >	direction_p
ScalarColumn< Double >	interval_p
ScalarColumn< String >	name_p
ScalarColumn< Int >	numLines_p
ArrayColumn< Double >	properMotion_p
ScalarColumn< Int >	sourceId_p
ScalarColumn< Int >	spectralWindowId_p
ScalarColumn< Double >	time_p
ArrayColumn< Double >	position_p
ScalarColumn< Int >	pulsarId_p
ArrayColumn< Double >	restFrequency_p
ScalarColumn< TableRecord >	sourceModel_p
ArrayColumn< Double >	sysvel_p
ArrayColumn< String >	transition_p
ScalarMeasColumn< MDirection >	directionMeas_p
ScalarMeasColumn< MEpoch >	timeMeas_p
ScalarMeasColumn< MPosition >	positionMeas_p
ArrayMeasColumn< MFrequency >	restFrequencyMeas_p
ArrayMeasColumn< MRadialVelocity >	sysvelMeas_p
ArrayQuantColumn< Double >	directionQuant_p
ScalarQuantColumn< Double >	intervalQuant_p
ArrayQuantColumn< Double >	properMotionQuant_p
ScalarQuantColumn< Double >	timeQuant_p
ArrayQuantColumn< Double >	positionQuant_p
ArrayQuantColumn< Double >	restFrequencyQuant_p
ArrayQuantColumn< Double >	sysvelQuant_p

casa::MSSourceColumns Class Reference [MeasurementSets]

Detailed Description

Intended use:

Review Status

Prerequisite

Etymology

Synopsis

Motivation

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

casa::MSSourceColumns Class Reference
[MeasurementSets]