casacore::ROMSStateColumns Class Reference

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

#include <MSStateColumns.h>

Inheritance diagram for casacore::ROMSStateColumns:

Public Member Functions
	ROMSStateColumns (const MSState &msState)
	Create a columns object that accesses the data in the specified Table. More...
	~ROMSStateColumns ()
	The destructor does nothing special. More...
const ROScalarColumn< Double > &	cal () const
	Access to required columns. More...
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. More...
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. More...

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

• MSState
• ScalarColumn

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

casacore::ROMSStateColumns::ROMSStateColumns

(

const MSState &

msState

)

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

casacore::ROMSStateColumns::~ROMSStateColumns

(

)

The destructor does nothing special.

casacore::ROMSStateColumns::ROMSStateColumns ( )

protected

casacore::ROMSStateColumns::ROMSStateColumns ( const ROMSStateColumns &  )

private

Member Function Documentation

void casacore::ROMSStateColumns::attach ( const MSState &  msState )

protected

const ROScalarColumn<Double>& casacore::ROMSStateColumns::cal ( ) const

inline

Access to required columns.

Definition at line 83 of file MSStateColumns.h.

References cal_p.

const ROScalarQuantColumn<Double>& casacore::ROMSStateColumns::calQuant ( ) const

inline

Definition at line 84 of file MSStateColumns.h.

References calQuant_p.

const ROScalarColumn<Bool>& casacore::ROMSStateColumns::flagRow ( ) const

inline

Definition at line 85 of file MSStateColumns.h.

References flagRow_p.

const ROScalarColumn<Double>& casacore::ROMSStateColumns::load ( ) const

inline

Definition at line 86 of file MSStateColumns.h.

References load_p.

const ROScalarQuantColumn<Double>& casacore::ROMSStateColumns::loadQuant ( ) const

inline

Definition at line 87 of file MSStateColumns.h.

References loadQuant_p.

Int casacore::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 casacore::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>& casacore::ROMSStateColumns::obsMode ( ) const

inline

Definition at line 88 of file MSStateColumns.h.

References obsMode_p.

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

private

const ROScalarColumn<Bool>& casacore::ROMSStateColumns::ref ( ) const

inline

Definition at line 89 of file MSStateColumns.h.

References ref_p.

const ROScalarColumn<Bool>& casacore::ROMSStateColumns::sig ( ) const

inline

Definition at line 90 of file MSStateColumns.h.

References sig_p.

const ROScalarColumn<Int>& casacore::ROMSStateColumns::subScan ( ) const

inline

Definition at line 91 of file MSStateColumns.h.

References subScan_p.

Member Data Documentation

ROScalarColumn<Double> casacore::ROMSStateColumns::cal_p

private

Definition at line 129 of file MSStateColumns.h.

Referenced by cal(), and nrow().

ROScalarQuantColumn<Double> casacore::ROMSStateColumns::calQuant_p

private

Definition at line 138 of file MSStateColumns.h.

Referenced by calQuant().

ROScalarColumn<Bool> casacore::ROMSStateColumns::flagRow_p

private

Definition at line 130 of file MSStateColumns.h.

Referenced by flagRow().

ROScalarColumn<Double> casacore::ROMSStateColumns::load_p

private

Definition at line 131 of file MSStateColumns.h.

Referenced by load().

ROScalarQuantColumn<Double> casacore::ROMSStateColumns::loadQuant_p

private

Definition at line 139 of file MSStateColumns.h.

Referenced by loadQuant().

ROScalarColumn<String> casacore::ROMSStateColumns::obsMode_p

private

Definition at line 132 of file MSStateColumns.h.

Referenced by obsMode().

ROScalarColumn<Bool> casacore::ROMSStateColumns::ref_p

private

Definition at line 133 of file MSStateColumns.h.

Referenced by ref().

ROScalarColumn<Bool> casacore::ROMSStateColumns::sig_p

private

Definition at line 134 of file MSStateColumns.h.

Referenced by sig().

ROScalarColumn<Int> casacore::ROMSStateColumns::subScan_p

private

Definition at line 135 of file MSStateColumns.h.

Referenced by subScan().

---

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

• casa/casacore/ms/MeasurementSets/MSStateColumns.h