casacore::MSStateColumns Class Reference

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

#include <MSStateColumns.h>

Inheritance diagram for casacore::MSStateColumns:

Public Member Functions
	MSStateColumns (MSState &msState)
	Create a columns object that accesses the data in the specified Table. More...
	~MSStateColumns ()
	The destructor does nothing special. More...
ScalarColumn< Double > &	cal ()
	Read-write access to required columns. More...
ScalarQuantColumn< Double > &	calQuant ()
ScalarColumn< Bool > &	flagRow ()
ScalarColumn< Double > &	load ()
ScalarQuantColumn< Double > &	loadQuant ()
ScalarColumn< String > &	obsMode ()
ScalarColumn< Bool > &	ref ()
ScalarColumn< Bool > &	sig ()
ScalarColumn< Int > &	subScan ()
Public Member Functions inherited from casacore::ROMSStateColumns
	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
	MSStateColumns ()
	Read-only access to required columns. More...
void	attach (MSState &msState)
Protected Member Functions inherited from casacore::ROMSStateColumns
	ROMSStateColumns ()
void	attach (const MSState &msState)

Private Member Functions
	MSStateColumns (const MSStateColumns &)
MSStateColumns &	operator= (const MSStateColumns &)

Private Attributes
ScalarColumn< Double >	cal_p
ScalarColumn< Bool >	flagRow_p
ScalarColumn< Double >	load_p
ScalarColumn< String >	obsMode_p
ScalarColumn< Bool >	ref_p
ScalarColumn< Bool >	sig_p
ScalarColumn< Int >	subScan_p
ScalarQuantColumn< Double >	calQuant_p
	Access to Quantum columns. More...
ScalarQuantColumn< Double >	loadQuant_p

Detailed Description

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

Intended use:

Public interface

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MSState
• ScalarColumn

Etymology

MSStateColumns stands for MeasurementSet State Table columns.

Synopsis

This class provides 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 MSColumns for an example.

Motivation

See MSColumns for the motivation.

Definition at line 174 of file MSStateColumns.h.

Constructor & Destructor Documentation

casacore::MSStateColumns::MSStateColumns

(

MSState &

msState

)

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

casacore::MSStateColumns::~MSStateColumns

(

)

The destructor does nothing special.

casacore::MSStateColumns::MSStateColumns ( )

protected

Read-only access to required columns.

casacore::MSStateColumns::MSStateColumns ( const MSStateColumns &  )

private

Member Function Documentation

void casacore::MSStateColumns::attach ( MSState &  msState )

protected

ScalarColumn<Double>& casacore::MSStateColumns::cal ( )

inline

Read-write access to required columns.

Definition at line 185 of file MSStateColumns.h.

References cal_p.

ScalarQuantColumn<Double>& casacore::MSStateColumns::calQuant ( )

inline

Definition at line 186 of file MSStateColumns.h.

References calQuant_p.

ScalarColumn<Bool>& casacore::MSStateColumns::flagRow ( )

inline

Definition at line 187 of file MSStateColumns.h.

References flagRow_p.

ScalarColumn<Double>& casacore::MSStateColumns::load ( )

inline

Definition at line 188 of file MSStateColumns.h.

References load_p.

ScalarQuantColumn<Double>& casacore::MSStateColumns::loadQuant ( )

inline

Definition at line 189 of file MSStateColumns.h.

References loadQuant_p.

ScalarColumn<String>& casacore::MSStateColumns::obsMode ( )

inline

Definition at line 190 of file MSStateColumns.h.

References obsMode_p.

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

private

ScalarColumn<Bool>& casacore::MSStateColumns::ref ( )

inline

Definition at line 191 of file MSStateColumns.h.

References ref_p.

ScalarColumn<Bool>& casacore::MSStateColumns::sig ( )

inline

Definition at line 192 of file MSStateColumns.h.

References sig_p.

ScalarColumn<Int>& casacore::MSStateColumns::subScan ( )

inline

Definition at line 193 of file MSStateColumns.h.

References subScan_p.

Member Data Documentation

ScalarColumn<Double> casacore::MSStateColumns::cal_p

private

Definition at line 215 of file MSStateColumns.h.

Referenced by cal().

ScalarQuantColumn<Double> casacore::MSStateColumns::calQuant_p

private

Access to Quantum columns.

Definition at line 224 of file MSStateColumns.h.

Referenced by calQuant().

ScalarColumn<Bool> casacore::MSStateColumns::flagRow_p

private

Definition at line 216 of file MSStateColumns.h.

Referenced by flagRow().

ScalarColumn<Double> casacore::MSStateColumns::load_p

private

Definition at line 217 of file MSStateColumns.h.

Referenced by load().

ScalarQuantColumn<Double> casacore::MSStateColumns::loadQuant_p

private

Definition at line 225 of file MSStateColumns.h.

Referenced by loadQuant().

ScalarColumn<String> casacore::MSStateColumns::obsMode_p

private

Definition at line 218 of file MSStateColumns.h.

Referenced by obsMode().

ScalarColumn<Bool> casacore::MSStateColumns::ref_p

private

Definition at line 219 of file MSStateColumns.h.

Referenced by ref().

ScalarColumn<Bool> casacore::MSStateColumns::sig_p

private

Definition at line 220 of file MSStateColumns.h.

Referenced by sig().

ScalarColumn<Int> casacore::MSStateColumns::subScan_p

private

Definition at line 221 of file MSStateColumns.h.

Referenced by subScan().

---

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

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