casacore::MSHistoryColumns Class Reference

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

#include <MSHistoryColumns.h>

Inheritance diagram for casacore::MSHistoryColumns:

Public Member Functions
	MSHistoryColumns (MSHistory &msHistory)
	Create a columns object that accesses the data in the specified Table.
	~MSHistoryColumns ()
	The destructor does nothing special.
ScalarColumn< String > &	application ()
	Read-write access to required columns.
ArrayColumn< String > &	appParams ()
ArrayColumn< String > &	cliCommand ()
ScalarColumn< String > &	message ()
ScalarColumn< Int > &	objectId ()
ScalarColumn< Int > &	observationId ()
ScalarColumn< String > &	origin ()
ScalarColumn< String > &	priority ()
ScalarColumn< Double > &	time ()
ScalarQuantColumn< Double > &	timeQuant ()
ScalarMeasColumn< MEpoch > &	timeMeas ()
const ROScalarColumn< String > &	application () const
	Read-only access to required columns.
const ROArrayColumn< String > &	appParams () const
const ROArrayColumn< String > &	cliCommand () const
const ROScalarColumn< String > &	message () const
const ROScalarColumn< Int > &	objectId () const
const ROScalarColumn< Int > &	observationId () const
const ROScalarColumn< String > &	origin () const
const ROScalarColumn< String > &	priority () const
const ROScalarColumn< Double > &	time () const
const ROScalarQuantColumn < Double > &	timeQuant () const
const ROScalarMeasColumn < MEpoch > &	timeMeas () const
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch type for the TIME column.
Protected Member Functions
	MSHistoryColumns ()
void	attach (MSHistory &msHistory)
Private Member Functions
	MSHistoryColumns (const MSHistoryColumns &)
MSHistoryColumns &	operator= (const MSHistoryColumns &)
Private Attributes
ScalarColumn< String >	application_p
ArrayColumn< String >	appParams_p
ArrayColumn< String >	cliCommand_p
ScalarColumn< String >	message_p
ScalarColumn< Int >	objectId_p
ScalarColumn< Int >	observationId_p
ScalarColumn< String >	origin_p
ScalarColumn< String >	priority_p
ScalarColumn< Double >	time_p
ScalarMeasColumn< MEpoch >	timeMeas_p
ScalarQuantColumn< Double >	timeQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

MSHistoryColumns stands for MeasurementSet History Table columns.

Synopsis

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

Note by GvD 28-Jan-2010: According to note 229 the OBJECTID column should contain Strings. It is, however, defined as Int. It has to be left as such, otherwise older MeasurementSets cannot be read anymore.

Motivation

See MSColumns for the motivation.

Definition at line 173 of file MSHistoryColumns.h.

Constructor & Destructor Documentation

casacore::MSHistoryColumns::MSHistoryColumns ( MSHistory & msHistory )

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

casacore::MSHistoryColumns::~MSHistoryColumns ( )

The destructor does nothing special.

casacore::MSHistoryColumns::MSHistoryColumns ( ) [protected]

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

Member Function Documentation

const ROScalarColumn<String>& casacore::MSHistoryColumns::application ( ) const [inline]

Read-only access to required columns.

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 199 of file MSHistoryColumns.h.

References application().

ScalarColumn<String>& casacore::MSHistoryColumns::application ( ) [inline]

Read-write access to required columns.

Definition at line 184 of file MSHistoryColumns.h.

References application_p.

Referenced by application().

const ROArrayColumn<String>& casacore::MSHistoryColumns::appParams ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 201 of file MSHistoryColumns.h.

References appParams().

ArrayColumn<String>& casacore::MSHistoryColumns::appParams ( ) [inline]

Definition at line 185 of file MSHistoryColumns.h.

References appParams_p.

Referenced by appParams().

void casacore::MSHistoryColumns::attach ( MSHistory & msHistory ) [protected]

const ROArrayColumn<String>& casacore::MSHistoryColumns::cliCommand ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 203 of file MSHistoryColumns.h.

References cliCommand().

ArrayColumn<String>& casacore::MSHistoryColumns::cliCommand ( ) [inline]

Definition at line 186 of file MSHistoryColumns.h.

References cliCommand_p.

Referenced by cliCommand().

const ROScalarColumn<String>& casacore::MSHistoryColumns::message ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 205 of file MSHistoryColumns.h.

References message().

ScalarColumn<String>& casacore::MSHistoryColumns::message ( ) [inline]

Definition at line 187 of file MSHistoryColumns.h.

References message_p.

Referenced by message().

const ROScalarColumn<Int>& casacore::MSHistoryColumns::objectId ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 207 of file MSHistoryColumns.h.

References objectId().

ScalarColumn<Int>& casacore::MSHistoryColumns::objectId ( ) [inline]

Definition at line 188 of file MSHistoryColumns.h.

References objectId_p.

Referenced by objectId().

const ROScalarColumn<Int>& casacore::MSHistoryColumns::observationId ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 209 of file MSHistoryColumns.h.

References observationId().

ScalarColumn<Int>& casacore::MSHistoryColumns::observationId ( ) [inline]

Definition at line 189 of file MSHistoryColumns.h.

References observationId_p.

Referenced by observationId().

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

Reimplemented from casacore::ROMSHistoryColumns.

const ROScalarColumn<String>& casacore::MSHistoryColumns::origin ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 211 of file MSHistoryColumns.h.

References origin().

ScalarColumn<String>& casacore::MSHistoryColumns::origin ( ) [inline]

Definition at line 190 of file MSHistoryColumns.h.

References origin_p.

Referenced by origin().

const ROScalarColumn<String>& casacore::MSHistoryColumns::priority ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 213 of file MSHistoryColumns.h.

References priority().

ScalarColumn<String>& casacore::MSHistoryColumns::priority ( ) [inline]

Definition at line 191 of file MSHistoryColumns.h.

References priority_p.

Referenced by priority().

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

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

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 215 of file MSHistoryColumns.h.

References time().

ScalarColumn<Double>& casacore::MSHistoryColumns::time ( ) [inline]

Definition at line 192 of file MSHistoryColumns.h.

References time_p.

Referenced by time().

const ROScalarMeasColumn<MEpoch>& casacore::MSHistoryColumns::timeMeas ( ) const [inline]

Reimplemented from casacore::ROMSHistoryColumns.

Definition at line 219 of file MSHistoryColumns.h.

References timeMeas().