casacore::MSPolarizationColumns Class Reference

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

#include <MSPolColumns.h>

Public Member Functions
	MSPolarizationColumns (const MSPolarization &msPolarization)
	Create a columns object that accesses the data in the specified Table. More...
	~MSPolarizationColumns ()
	The destructor does nothing special. More...
ArrayColumn< Int > &	corrProduct ()
	Access to required columns. More...
ArrayColumn< Int > &	corrType ()
ScalarColumn< Bool > &	flagRow ()
ScalarColumn< Int > &	numCorr ()
const ArrayColumn< Int > &	corrProduct () const
	Const access to required columns. More...
const ArrayColumn< Int > &	corrType () const
const ScalarColumn< Bool > &	flagRow () const
const ScalarColumn< Int > &	numCorr () const
rownr_t	nrow () const
	Convenience function that returns the number of rows in any of the columns. More...
Int64	match (const Vector< Stokes::StokesTypes > &polType, Int64 tryRow=-1)
	returns the last row that contains the an entry in the CORR_TYPE column that matches, in length and value, the supplied corrType Vector. More...

Protected Member Functions
	MSPolarizationColumns ()
void	attach (const MSPolarization &msPolarization)

Private Member Functions
	MSPolarizationColumns (const MSPolarizationColumns &)
MSPolarizationColumns &	operator= (const MSPolarizationColumns &)
Bool	matchCorrType (rownr_t row, const Vector< Int > &polType) const
Bool	matchCorrProduct (rownr_t row, const Matrix< Int > &polProduct) const

Private Attributes
ArrayColumn< Int >	corrProduct_p
ArrayColumn< Int >	corrType_p
ScalarColumn< Bool >	flagRow_p
ScalarColumn< Int >	numCorr_p

Detailed Description

A class to provide easy access to MSPolarization columns.

Intended use:

Public interface

Review Status

Reviewed By:

Bob Garwood

Date Reviewed:

1997/02/01

Prerequisite

• MSPolarization
• ArrayColumn
• ScalarColumn

Etymology

MSPolarizationColumns stands for MeasurementSet Polarization Table columns.

Synopsis

This class provides access to the columns in the MSPolarization 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 74 of file MSPolColumns.h.

Constructor & Destructor Documentation

casacore::MSPolarizationColumns::MSPolarizationColumns

(

const MSPolarization &

msPolarization

)

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

casacore::MSPolarizationColumns::~MSPolarizationColumns

(

)

The destructor does nothing special.

casacore::MSPolarizationColumns::MSPolarizationColumns ( )

protected

casacore::MSPolarizationColumns::MSPolarizationColumns ( const MSPolarizationColumns &  )

private

Member Function Documentation

void casacore::MSPolarizationColumns::attach ( const MSPolarization &  msPolarization )

protected

ArrayColumn<Int>& casacore::MSPolarizationColumns::corrProduct ( )

inline

Access to required columns.

Definition at line 85 of file MSPolColumns.h.

References corrProduct_p.

const ArrayColumn<Int>& casacore::MSPolarizationColumns::corrProduct ( ) const

inline

Const access to required columns.

Definition at line 93 of file MSPolColumns.h.

References corrProduct_p.

ArrayColumn<Int>& casacore::MSPolarizationColumns::corrType ( )

inline

Definition at line 86 of file MSPolColumns.h.

References corrType_p.

const ArrayColumn<Int>& casacore::MSPolarizationColumns::corrType ( ) const

inline

Definition at line 94 of file MSPolColumns.h.

References corrType_p.

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

inline

Definition at line 87 of file MSPolColumns.h.

References flagRow_p.

const ScalarColumn<Bool>& casacore::MSPolarizationColumns::flagRow ( ) const

inline

Definition at line 95 of file MSPolColumns.h.

References flagRow_p.

Int64 casacore::MSPolarizationColumns::match	(	const Vector< Stokes::StokesTypes > &	polType,
		Int64	tryRow = -1
	)

returns the last row that contains the an entry in the CORR_TYPE column that matches, in length and value, the supplied corrType Vector.

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.

Bool casacore::MSPolarizationColumns::matchCorrProduct ( rownr_t  row, const Matrix< Int > &  polProduct  ) const

private

Bool casacore::MSPolarizationColumns::matchCorrType ( rownr_t  row, const Vector< Int > &  polType  ) const

private

rownr_t casacore::MSPolarizationColumns::nrow ( ) const

inline

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

Definition at line 100 of file MSPolColumns.h.

References corrProduct_p, and casacore::TableColumn::nrow().

ScalarColumn<Int>& casacore::MSPolarizationColumns::numCorr ( )

inline

Definition at line 88 of file MSPolColumns.h.

References numCorr_p.

const ScalarColumn<Int>& casacore::MSPolarizationColumns::numCorr ( ) const

inline

Definition at line 96 of file MSPolColumns.h.

References numCorr_p.

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

private

Member Data Documentation

ArrayColumn<Int> casacore::MSPolarizationColumns::corrProduct_p

private

Definition at line 131 of file MSPolColumns.h.

Referenced by corrProduct(), and nrow().

ArrayColumn<Int> casacore::MSPolarizationColumns::corrType_p

private

Definition at line 132 of file MSPolColumns.h.

Referenced by corrType().

ScalarColumn<Bool> casacore::MSPolarizationColumns::flagRow_p

private

Definition at line 133 of file MSPolColumns.h.

Referenced by flagRow().

ScalarColumn<Int> casacore::MSPolarizationColumns::numCorr_p

private

Definition at line 134 of file MSPolColumns.h.

Referenced by numCorr().

---

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

• ms/MeasurementSets/MSPolColumns.h