casacore::MSColumns Class Reference

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

#include <MSColumns.h>

Inheritance diagram for casacore::MSColumns:

Public Member Functions
	MSColumns (MeasurementSet &ms)
	Create a columns object that accesses the data in the specified MS.
	~MSColumns ()
	The destructor does nothing special.
MSAntennaColumns &	antenna ()
	Read-write access to required subtables.
MSDataDescColumns &	dataDescription ()
MSFeedColumns &	feed ()
MSFieldColumns &	field ()
MSFlagCmdColumns &	flagCmd ()
MSHistoryColumns &	history ()
MSObservationColumns &	observation ()
MSPointingColumns &	pointing ()
MSPolarizationColumns &	polarization ()
MSProcessorColumns &	processor ()
MSSpWindowColumns &	spectralWindow ()
MSStateColumns &	state ()
MSDopplerColumns &	doppler ()
	Read-write access to optional subtables.
MSFreqOffsetColumns &	freqOffset ()
MSSourceColumns &	source ()
MSSysCalColumns &	sysCal ()
MSWeatherColumns &	weather ()
const ROMSAntennaColumns &	antenna () const
	Read-only access to required subtables.
const ROMSDataDescColumns &	dataDescription () const
const ROMSFeedColumns &	feed () const
const ROMSFieldColumns &	field () const
const ROMSFlagCmdColumns &	flagCmd () const
const ROMSHistoryColumns &	history () const
const ROMSObservationColumns &	observation () const
const ROMSPointingColumns &	pointing () const
const ROMSPolarizationColumns &	polarization () const
const ROMSProcessorColumns &	processor () const
const ROMSSourceColumns &	source () const
const ROMSSpWindowColumns &	spectralWindow () const
const ROMSStateColumns &	state () const
const ROMSDopplerColumns &	doppler () const
	Read-only access to optional subtables.
const ROMSFreqOffsetColumns &	freqOffset () const
const ROMSSysCalColumns &	sysCal () const
const ROMSWeatherColumns &	weather () const
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the EPOCH reference type in all EPOCH columns in the MS.
void	setDirectionRef (MDirection::Types ref)
	set the DIRECTION reference type for FIELD, POINTING and SOURCE tables (except for antenna frame directions).
Private Attributes
MSAntennaColumns	antenna_p
	Access to subtables.
MSDataDescColumns	dataDesc_p
MSDopplerColumns	doppler_p
MSFeedColumns	feed_p
MSFieldColumns	field_p
MSFlagCmdColumns	flagCmd_p
MSFreqOffsetColumns	freqOffset_p
MSHistoryColumns	history_p
MSObservationColumns	observation_p
MSPointingColumns	pointing_p
MSPolarizationColumns	polarization_p
MSProcessorColumns	processor_p
MSSourceColumns	source_p
MSSpWindowColumns	spectralWindow_p
MSStateColumns	state_p
MSSysCalColumns	sysCal_p
MSWeatherColumns	weather_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSColumns stands for MeasurementSet Table columns.

Synopsis

This class provides access to all the subtables and direct access to all the columns in the MeasurementSet. 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.

Example

 // use as follows
 MeasurementSet ms("myMS",Table::Update); 
 MSColumns msc(ms);
 // show data from row 5
 cout << msc.data()(5);
 // change name of antenna on row 3 in antenna table
 msc.antenna().name().put(3,"NewAnt-3");

Motivation

Having to type long lists of Scalar and Array column declarations gets very tedious. This class attempts to relieve some of that tedium, while at the same time concentrating all the declarations in one place, making Type errors in the column declaration (only caught at run-time) less probable. Type errors in the use of the columns is caught at compile time.

To Do

We might decide to merge this class with the MeasurementSet

Definition at line 221 of file MSColumns.h.

Constructor & Destructor Documentation

casacore::MSColumns::MSColumns ( MeasurementSet & ms )

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

casacore::MSColumns::~MSColumns ( )

The destructor does nothing special.

Member Function Documentation

const ROMSAntennaColumns& casacore::MSColumns::antenna ( ) const [inline]

Read-only access to required subtables.

Definition at line 257 of file MSColumns.h.

References antenna_p.

MSAntennaColumns& casacore::MSColumns::antenna ( ) [inline]

Read-write access to required subtables.

Definition at line 232 of file MSColumns.h.

References antenna_p.

const ROMSDataDescColumns& casacore::MSColumns::dataDescription ( ) const [inline]

Definition at line 258 of file MSColumns.h.

References dataDesc_p.

MSDataDescColumns& casacore::MSColumns::dataDescription ( ) [inline]

Definition at line 233 of file MSColumns.h.

References dataDesc_p.

const ROMSDopplerColumns& casacore::MSColumns::doppler ( ) const [inline]

Read-only access to optional subtables.

Definition at line 276 of file MSColumns.h.

References doppler_p.

MSDopplerColumns& casacore::MSColumns::doppler ( ) [inline]

Read-write access to optional subtables.

Definition at line 248 of file MSColumns.h.

References doppler_p.

const ROMSFeedColumns& casacore::MSColumns::feed ( ) const [inline]

Definition at line 259 of file MSColumns.h.

References feed_p.

MSFeedColumns& casacore::MSColumns::feed ( ) [inline]

Definition at line 234 of file MSColumns.h.

References feed_p.

const ROMSFieldColumns& casacore::MSColumns::field ( ) const [inline]

Definition at line 260 of file MSColumns.h.

References field_p.

MSFieldColumns& casacore::MSColumns::field ( ) [inline]

Definition at line 235 of file MSColumns.h.

References field_p.

const ROMSFlagCmdColumns& casacore::MSColumns::flagCmd ( ) const [inline]

Definition at line 261 of file MSColumns.h.

References flagCmd_p.

MSFlagCmdColumns& casacore::MSColumns::flagCmd ( ) [inline]

Definition at line 236 of file MSColumns.h.

References flagCmd_p.

const ROMSFreqOffsetColumns& casacore::MSColumns::freqOffset ( ) const [inline]

Definition at line 277 of file MSColumns.h.

References freqOffset_p.

MSFreqOffsetColumns& casacore::MSColumns::freqOffset ( ) [inline]

Definition at line 249 of file MSColumns.h.

References freqOffset_p.

const ROMSHistoryColumns& casacore::MSColumns::history ( ) const [inline]

Definition at line 262 of file MSColumns.h.

References history_p.

MSHistoryColumns& casacore::MSColumns::history ( ) [inline]

Definition at line 237 of file MSColumns.h.

References history_p.

const ROMSObservationColumns& casacore::MSColumns::observation ( ) const [inline]

Definition at line 263 of file MSColumns.h.

References observation_p.

MSObservationColumns& casacore::MSColumns::observation ( ) [inline]

Definition at line 238 of file MSColumns.h.

References observation_p.

const ROMSPointingColumns& casacore::MSColumns::pointing ( ) const [inline]

Definition at line 264 of file MSColumns.h.

References pointing_p.

MSPointingColumns& casacore::MSColumns::pointing ( ) [inline]

Definition at line 239 of file MSColumns.h.

References pointing_p.

const ROMSPolarizationColumns& casacore::MSColumns::polarization ( ) const [inline]

Definition at line 265 of file MSColumns.h.

References polarization_p.

MSPolarizationColumns& casacore::MSColumns::polarization ( ) [inline]

Definition at line 240 of file MSColumns.h.

References polarization_p.

const ROMSProcessorColumns& casacore::MSColumns::processor ( ) const [inline]

Definition at line 267 of file MSColumns.h.

References processor_p.

MSProcessorColumns& casacore::MSColumns::processor ( ) [inline]

Definition at line 241 of file MSColumns.h.

References processor_p.

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

set the DIRECTION reference type for FIELD, POINTING and SOURCE tables (except for antenna frame directions).

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

set the EPOCH reference type in all EPOCH columns in the MS.

Note that only a single EPOCH reference is allowed in the MS. This
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;

Reimplemented from casacore::MSMainColumns.

const ROMSSourceColumns& casacore::MSColumns::source ( ) const [inline]

Definition at line 268 of file MSColumns.h.

References source_p.

MSSourceColumns& casacore::MSColumns::source ( ) [inline]

Definition at line 250 of file MSColumns.h.

References source_p.

const ROMSSpWindowColumns& casacore::MSColumns::spectralWindow ( ) const [inline]

Definition at line 269 of file MSColumns.h.

References spectralWindow_p.

MSSpWindowColumns& casacore::MSColumns::spectralWindow ( ) [inline]

Definition at line 242 of file MSColumns.h.