A class to provide easy read-only access to MSState columns. More...

#include <MSStateColumns.h>

Inheritance diagram for casa::ROMSStateColumns:

Public Member Functions
	ROMSStateColumns (const MSState &msState)
	Create a columns object that accesses the data in the specified Table.
	~ROMSStateColumns ()
	The destructor does nothing special.
const ROScalarColumn< Double > &	cal () const
	Access to required columns.
const ROScalarQuantColumn < Double > &	calQuant () const
const ROScalarColumn< Bool > &	flagRow () const
const ROScalarColumn< Double > &	load () const
const ROScalarQuantColumn < Double > &	loadQuant () const
const ROScalarColumn< String > &	obsMode () const
const ROScalarColumn< Bool > &	ref () const
const ROScalarColumn< Bool > &	sig () const
const ROScalarColumn< Int > &	subScan () const
uInt	nrow () const
	Convenience function that returns the number of rows in any of the columns.
Int	matchState (const Quantum< Double > &stateCalQ, const Quantum< Double > &stateLoadQ, const String &stateObsMode, const Bool &stateRef, const Bool &stateSig, const Int &stateSubScan, const Quantum< Double > &tolerance, Int tryRow=-1)
	Returns the last row that contains a state with the specified values.
Protected Member Functions
	ROMSStateColumns ()
void	attach (const MSState &msState)
Private Member Functions
	ROMSStateColumns (const ROMSStateColumns &)
ROMSStateColumns &	operator= (const ROMSStateColumns &)
Private Attributes
ROScalarColumn< Double >	cal_p
ROScalarColumn< Bool >	flagRow_p
ROScalarColumn< Double >	load_p
ROScalarColumn< String >	obsMode_p
ROScalarColumn< Bool >	ref_p
ROScalarColumn< Bool >	sig_p
ROScalarColumn< Int >	subScan_p
ROScalarQuantColumn< Double >	calQuant_p
ROScalarQuantColumn< Double >	loadQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

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

Prerequisite

Etymology

ROMSStateColumns stands for Read-Only MeasurementSet State Table columns.

Synopsis

This class provides read-only access to the columns in the MSState 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 72 of file MSStateColumns.h.

Constructor & Destructor Documentation

casa::ROMSStateColumns::ROMSStateColumns ( const MSState & msState )

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

casa::ROMSStateColumns::~ROMSStateColumns ( )

The destructor does nothing special.

casa::ROMSStateColumns::ROMSStateColumns ( ) [protected]

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

Member Function Documentation

void casa::ROMSStateColumns::attach ( const MSState & msState ) [protected]

const ROScalarColumn<Double>& casa::ROMSStateColumns::cal ( ) const [inline]

Access to required columns.

Definition at line 83 of file MSStateColumns.h.

References cal_p.

const ROScalarQuantColumn<Double>& casa::ROMSStateColumns::calQuant ( ) const [inline]

Definition at line 84 of file MSStateColumns.h.

References calQuant_p.

const ROScalarColumn<Bool>& casa::ROMSStateColumns::flagRow ( ) const [inline]

Definition at line 85 of file MSStateColumns.h.

References flagRow_p.

const ROScalarColumn<Double>& casa::ROMSStateColumns::load ( ) const [inline]

Definition at line 86 of file MSStateColumns.h.

References load_p.

const ROScalarQuantColumn<Double>& casa::ROMSStateColumns::loadQuant ( ) const [inline]

Definition at line 87 of file MSStateColumns.h.

References loadQuant_p.

Int casa::ROMSStateColumns::matchState	(	const Quantum< Double > &	stateCalQ,
		const Quantum< Double > &	stateLoadQ,
		const String &	stateObsMode,
		const Bool &	stateRef,
		const Bool &	stateSig,
		const Int &	stateSubScan,
		const Quantum< Double > &	tolerance,
		Int	tryRow = `-1`
	)

Returns the last row that contains a state with the specified values.

For Cal and Load, the tolerance is applied in the match. Returns -1 if no match could be found. Flagged rows can never match. If tryRow is non-negative, then that row is tested to see if it matches before any others are tested. Setting tryRow to a positive value greater than the table length will throw an exception (AipsError), when compiled in debug mode.

uInt casa::ROMSStateColumns::nrow ( ) const [inline]

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

Definition at line 95 of file MSStateColumns.h.

References cal_p.

const ROScalarColumn<String>& casa::ROMSStateColumns::obsMode ( ) const [inline]

Definition at line 88 of file MSStateColumns.h.

References obsMode_p.

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