casacore::MSHistoryColumns Class Reference

A class to provide easy access to MSHistory columns. More...

#include <MSHistoryColumns.h>

Public Member Functions
	MSHistoryColumns (const MSHistory &msHistory)
	Create a columns object that accesses the data in the specified Table. More...
	~MSHistoryColumns ()
	The destructor does nothing special. More...
ScalarColumn< String > &	application ()
	Access to required columns. More...
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 ScalarColumn< String > &	application () const
	Const access to required columns. More...
const ArrayColumn< String > &	appParams () const
const ArrayColumn< String > &	cliCommand () const
const ScalarColumn< String > &	message () const
const ScalarColumn< Int > &	objectId () const
const ScalarColumn< Int > &	observationId () const
const ScalarColumn< String > &	origin () const
const ScalarColumn< String > &	priority () const
const ScalarColumn< Double > &	time () const
const ScalarQuantColumn< Double > &	timeQuant () const
const ScalarMeasColumn< MEpoch > &	timeMeas () const
rownr_t	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...
void	setEpochRef (MEpoch::Types ref, Bool tableMustBeEmpty=True)
	set the epoch type for the TIME column. More...

Protected Member Functions
	MSHistoryColumns ()
void	attach (const 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 access to MSHistory columns.

Intended use:

Public interface

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MSHistory
• ArrayColumn
• ScalarColumn

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 82 of file MSHistoryColumns.h.

Constructor & Destructor Documentation

casacore::MSHistoryColumns::MSHistoryColumns

(

const 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

ScalarColumn<String>& casacore::MSHistoryColumns::application ( )

inline

Access to required columns.

Definition at line 93 of file MSHistoryColumns.h.

References application_p.

const ScalarColumn<String>& casacore::MSHistoryColumns::application ( ) const

inline

Const access to required columns.

Definition at line 108 of file MSHistoryColumns.h.

References application_p.

ArrayColumn<String>& casacore::MSHistoryColumns::appParams ( )

inline

Definition at line 94 of file MSHistoryColumns.h.

References appParams_p.

const ArrayColumn<String>& casacore::MSHistoryColumns::appParams ( ) const

inline

Definition at line 109 of file MSHistoryColumns.h.

References appParams_p.

void casacore::MSHistoryColumns::attach ( const MSHistory &  msHistory )

protected

ArrayColumn<String>& casacore::MSHistoryColumns::cliCommand ( )

inline

Definition at line 95 of file MSHistoryColumns.h.

References cliCommand_p.

const ArrayColumn<String>& casacore::MSHistoryColumns::cliCommand ( ) const

inline

Definition at line 110 of file MSHistoryColumns.h.

References cliCommand_p.

ScalarColumn<String>& casacore::MSHistoryColumns::message ( )

inline

Definition at line 96 of file MSHistoryColumns.h.

References message_p.

const ScalarColumn<String>& casacore::MSHistoryColumns::message ( ) const

inline

Definition at line 111 of file MSHistoryColumns.h.

References message_p.

rownr_t casacore::MSHistoryColumns::nrow ( ) const

inline

Convenience function that returns the number of rows in any of the columns.

Definition at line 122 of file MSHistoryColumns.h.

References application_p.

ScalarColumn<Int>& casacore::MSHistoryColumns::objectId ( )

inline

Definition at line 97 of file MSHistoryColumns.h.

References objectId_p.

const ScalarColumn<Int>& casacore::MSHistoryColumns::objectId ( ) const

inline

Definition at line 112 of file MSHistoryColumns.h.

References objectId_p.

ScalarColumn<Int>& casacore::MSHistoryColumns::observationId ( )

inline

Definition at line 98 of file MSHistoryColumns.h.

References observationId_p.

const ScalarColumn<Int>& casacore::MSHistoryColumns::observationId ( ) const

inline

Definition at line 113 of file MSHistoryColumns.h.

References observationId_p.

MSHistoryColumns& casacore::MSHistoryColumns::operator= ( const MSHistoryColumns &  )

private

ScalarColumn<String>& casacore::MSHistoryColumns::origin ( )

inline

Definition at line 99 of file MSHistoryColumns.h.

References origin_p.

const ScalarColumn<String>& casacore::MSHistoryColumns::origin ( ) const

inline

Definition at line 114 of file MSHistoryColumns.h.

References origin_p.

ScalarColumn<String>& casacore::MSHistoryColumns::priority ( )

inline

Definition at line 100 of file MSHistoryColumns.h.

References priority_p.

const ScalarColumn<String>& casacore::MSHistoryColumns::priority ( ) const

inline

Definition at line 115 of file MSHistoryColumns.h.

References priority_p.

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;

ScalarColumn<Double>& casacore::MSHistoryColumns::time ( )

inline

Definition at line 101 of file MSHistoryColumns.h.

References time_p.

const ScalarColumn<Double>& casacore::MSHistoryColumns::time ( ) const

inline

Definition at line 116 of file MSHistoryColumns.h.

References time_p.

ScalarMeasColumn<MEpoch>& casacore::MSHistoryColumns::timeMeas ( )

inline

Definition at line 103 of file MSHistoryColumns.h.

References timeMeas_p.

const ScalarMeasColumn<MEpoch>& casacore::MSHistoryColumns::timeMeas ( ) const

inline

Definition at line 118 of file MSHistoryColumns.h.

References timeMeas_p.

ScalarQuantColumn<Double>& casacore::MSHistoryColumns::timeQuant ( )

inline

Definition at line 102 of file MSHistoryColumns.h.

References timeQuant_p.

const ScalarQuantColumn<Double>& casacore::MSHistoryColumns::timeQuant ( ) const

inline

Definition at line 117 of file MSHistoryColumns.h.

References timeQuant_p.

Member Data Documentation

ScalarColumn<String> casacore::MSHistoryColumns::application_p

private

Definition at line 150 of file MSHistoryColumns.h.

Referenced by application(), and nrow().

ArrayColumn<String> casacore::MSHistoryColumns::appParams_p

private

Definition at line 151 of file MSHistoryColumns.h.

Referenced by appParams().

ArrayColumn<String> casacore::MSHistoryColumns::cliCommand_p

private

Definition at line 152 of file MSHistoryColumns.h.

Referenced by cliCommand().

ScalarColumn<String> casacore::MSHistoryColumns::message_p

private

Definition at line 153 of file MSHistoryColumns.h.

Referenced by message().

ScalarColumn<Int> casacore::MSHistoryColumns::objectId_p

private

Definition at line 154 of file MSHistoryColumns.h.

Referenced by objectId().

ScalarColumn<Int> casacore::MSHistoryColumns::observationId_p

private

Definition at line 155 of file MSHistoryColumns.h.

Referenced by observationId().

ScalarColumn<String> casacore::MSHistoryColumns::origin_p

private

Definition at line 156 of file MSHistoryColumns.h.

Referenced by origin().

ScalarColumn<String> casacore::MSHistoryColumns::priority_p

private

Definition at line 157 of file MSHistoryColumns.h.

Referenced by priority().

ScalarColumn<Double> casacore::MSHistoryColumns::time_p

private

Definition at line 158 of file MSHistoryColumns.h.

Referenced by time().

ScalarMeasColumn<MEpoch> casacore::MSHistoryColumns::timeMeas_p

private

Definition at line 161 of file MSHistoryColumns.h.

Referenced by timeMeas().

ScalarQuantColumn<Double> casacore::MSHistoryColumns::timeQuant_p

private

Definition at line 164 of file MSHistoryColumns.h.

Referenced by timeQuant().

---

The documentation for this class was generated from the following file:

• ms/MeasurementSets/MSHistoryColumns.h