casa::ROMSHistoryColumns Class Reference
[MeasurementSets]

#include <MSHistoryColumns.h>

Inheritance diagram for casa::ROMSHistoryColumns:

[legend]List of all members.

---

Detailed Description

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

Intended use:

Part of API

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MSHistory
• ArrayColumn
• ScalarColumn

Etymology

ROMSHistoryColumns stands for Read-Only MeasurementSet History Table columns.

Synopsis

This class provides read-only 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 ROMSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 75 of file MSHistoryColumns.h.

Public Member Functions
	ROMSHistoryColumns (const MSHistory &msHistory)
	Create a columns object that accesses the data in the specified Table.
	~ROMSHistoryColumns ()
	The destructor does nothing special.
uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns.
const ROScalarColumn< String > &	application () const
	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
Protected Member Functions
	ROMSHistoryColumns ()
void	attach (const MSHistory &msHistory)
Private Member Functions
	ROMSHistoryColumns (const ROMSHistoryColumns &)
ROMSHistoryColumns &	operator= (const ROMSHistoryColumns &)
Private Attributes
ROScalarColumn< String >	application_p
ROArrayColumn< String >	appParams_p
ROArrayColumn< String >	cliCommand_p
ROScalarColumn< String >	message_p
ROScalarColumn< Int >	objectId_p
ROScalarColumn< Int >	observationId_p
ROScalarColumn< String >	origin_p
ROScalarColumn< String >	priority_p
ROScalarColumn< Double >	time_p
ROScalarMeasColumn< MEpoch >	timeMeas_p
ROScalarQuantColumn< Double >	timeQuant_p

---

Constructor & Destructor Documentation

casa::ROMSHistoryColumns::ROMSHistoryColumns

(

const MSHistory &

msHistory

)

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

casa::ROMSHistoryColumns::~ROMSHistoryColumns

(

)

The destructor does nothing special.

casa::ROMSHistoryColumns::ROMSHistoryColumns

(

)

[protected]

casa::ROMSHistoryColumns::ROMSHistoryColumns

(

const ROMSHistoryColumns &

)

[private]

---

Member Function Documentation

const ROScalarColumn<String>& casa::ROMSHistoryColumns::application

(

)

const [inline]

Access to required columns.

Definition at line 86 of file MSHistoryColumns.h.

References application_p.

Referenced by casa::MSHistoryColumns::application().

const ROArrayColumn<String>& casa::ROMSHistoryColumns::appParams

(

)

const [inline]

Definition at line 87 of file MSHistoryColumns.h.

References appParams_p.

Referenced by casa::MSHistoryColumns::appParams().

const ROArrayColumn<String>& casa::ROMSHistoryColumns::cliCommand

(

)

const [inline]

Definition at line 88 of file MSHistoryColumns.h.

References cliCommand_p.

Referenced by casa::MSHistoryColumns::cliCommand().

const ROScalarColumn<String>& casa::ROMSHistoryColumns::message

(

)

const [inline]

Definition at line 89 of file MSHistoryColumns.h.

References message_p.

Referenced by casa::MSHistoryColumns::message().

const ROScalarColumn<Int>& casa::ROMSHistoryColumns::objectId

(

)

const [inline]

Definition at line 90 of file MSHistoryColumns.h.

References objectId_p.

Referenced by casa::MSHistoryColumns::objectId().

const ROScalarColumn<Int>& casa::ROMSHistoryColumns::observationId

(

)

const [inline]

Definition at line 91 of file MSHistoryColumns.h.

References observationId_p.

Referenced by casa::MSHistoryColumns::observationId().

const ROScalarColumn<String>& casa::ROMSHistoryColumns::origin

(

)

const [inline]

Definition at line 92 of file MSHistoryColumns.h.

References origin_p.

Referenced by casa::MSHistoryColumns::origin().

const ROScalarColumn<String>& casa::ROMSHistoryColumns::priority

(

)

const [inline]

Definition at line 93 of file MSHistoryColumns.h.

References priority_p.

Referenced by casa::MSHistoryColumns::priority().

const ROScalarColumn<Double>& casa::ROMSHistoryColumns::time

(

)

const [inline]

Definition at line 94 of file MSHistoryColumns.h.

References time_p.

const ROScalarQuantColumn<Double>& casa::ROMSHistoryColumns::timeQuant

(

)

const [inline]

Definition at line 95 of file MSHistoryColumns.h.

References timeQuant_p.

Referenced by casa::MSHistoryColumns::timeQuant().

const ROScalarMeasColumn<MEpoch>& casa::ROMSHistoryColumns::timeMeas

(

)

const [inline]

Definition at line 96 of file MSHistoryColumns.h.

References timeMeas_p.

Referenced by casa::MSHistoryColumns::timeMeas().

uInt casa::ROMSHistoryColumns::nrow

(

)

const [inline]

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

Definition at line 100 of file MSHistoryColumns.h.

References application_p.

void casa::ROMSHistoryColumns::attach

(

const MSHistory &

msHistory

)

[protected]

ROMSHistoryColumns& casa::ROMSHistoryColumns::operator=

(

const ROMSHistoryColumns &

)

[private]

---

Member Data Documentation

ROScalarColumn<String> casa::ROMSHistoryColumns::application_p [private]

Definition at line 117 of file MSHistoryColumns.h.

Referenced by application(), and nrow().

ROArrayColumn<String> casa::ROMSHistoryColumns::appParams_p [private]

Definition at line 118 of file MSHistoryColumns.h.

Referenced by appParams().

ROArrayColumn<String> casa::ROMSHistoryColumns::cliCommand_p [private]

Definition at line 119 of file MSHistoryColumns.h.

Referenced by cliCommand().

ROScalarColumn<String> casa::ROMSHistoryColumns::message_p [private]

Definition at line 120 of file MSHistoryColumns.h.

Referenced by message().

ROScalarColumn<Int> casa::ROMSHistoryColumns::objectId_p [private]

Definition at line 121 of file MSHistoryColumns.h.

Referenced by objectId().

ROScalarColumn<Int> casa::ROMSHistoryColumns::observationId_p [private]

Definition at line 122 of file MSHistoryColumns.h.

Referenced by observationId().

ROScalarColumn<String> casa::ROMSHistoryColumns::origin_p [private]

Definition at line 123 of file MSHistoryColumns.h.

Referenced by origin().

ROScalarColumn<String> casa::ROMSHistoryColumns::priority_p [private]

Definition at line 124 of file MSHistoryColumns.h.

Referenced by priority().

ROScalarColumn<Double> casa::ROMSHistoryColumns::time_p [private]

Definition at line 125 of file MSHistoryColumns.h.

Referenced by time().

ROScalarMeasColumn<MEpoch> casa::ROMSHistoryColumns::timeMeas_p [private]

Definition at line 128 of file MSHistoryColumns.h.

Referenced by timeMeas().

ROScalarQuantColumn<Double> casa::ROMSHistoryColumns::timeQuant_p [private]

Definition at line 131 of file MSHistoryColumns.h.

Referenced by timeQuant().

---

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

• ms/implement/MeasurementSets/MSHistoryColumns.h

---