casacore
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
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
 
uInt nrow () const
 Convenience function that returns the number of rows in any of the columns. More...
 
Int match (const Vector< Stokes::StokesTypes > &polType, Int 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 &)
 
MSPolarizationColumnsoperator= (const MSPolarizationColumns &)
 
Bool matchCorrType (uInt row, const Vector< Int > &polType) const
 
Bool matchCorrProduct (uInt row, const Matrix< Int > &polProduct) const
 

Private Attributes

ArrayColumn< IntcorrProduct_p
 
ArrayColumn< IntcorrType_p
 
ScalarColumn< BoolflagRow_p
 
ScalarColumn< IntnumCorr_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

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 75 of file MSPolColumns.h.

Constructor & Destructor Documentation

◆ MSPolarizationColumns() [1/3]

casacore::MSPolarizationColumns::MSPolarizationColumns ( const MSPolarization msPolarization)

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

◆ ~MSPolarizationColumns()

casacore::MSPolarizationColumns::~MSPolarizationColumns ( )

The destructor does nothing special.

◆ MSPolarizationColumns() [2/3]

casacore::MSPolarizationColumns::MSPolarizationColumns ( )
protected

Referenced by nrow().

◆ MSPolarizationColumns() [3/3]

casacore::MSPolarizationColumns::MSPolarizationColumns ( const MSPolarizationColumns )
private

Member Function Documentation

◆ attach()

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

Referenced by nrow().

◆ corrProduct() [1/2]

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

Access to required columns.

Definition at line 86 of file MSPolColumns.h.

References corrProduct_p.

◆ corrProduct() [2/2]

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

Const access to required columns.

Definition at line 94 of file MSPolColumns.h.

References corrProduct_p.

◆ corrType() [1/2]

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

Definition at line 87 of file MSPolColumns.h.

References corrType_p.

◆ corrType() [2/2]

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

Definition at line 95 of file MSPolColumns.h.

References corrType_p.

◆ flagRow() [1/2]

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

Definition at line 88 of file MSPolColumns.h.

References flagRow_p.

◆ flagRow() [2/2]

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

Definition at line 96 of file MSPolColumns.h.

References flagRow_p.

◆ match()

Int casacore::MSPolarizationColumns::match ( const Vector< Stokes::StokesTypes > &  polType,
Int  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.

Referenced by nrow().

◆ matchCorrProduct()

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

Referenced by nrow().

◆ matchCorrType()

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

Referenced by nrow().

◆ nrow()

uInt casacore::MSPolarizationColumns::nrow ( ) const
inline

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

Definition at line 101 of file MSPolColumns.h.

References attach(), corrProduct_p, match(), matchCorrProduct(), matchCorrType(), MSPolarizationColumns(), casacore::TableColumn::nrow(), and operator=().

◆ numCorr() [1/2]

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

Definition at line 89 of file MSPolColumns.h.

References numCorr_p.

◆ numCorr() [2/2]

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

Definition at line 97 of file MSPolColumns.h.

References numCorr_p.

◆ operator=()

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

Referenced by nrow().

Member Data Documentation

◆ corrProduct_p

ArrayColumn<Int> casacore::MSPolarizationColumns::corrProduct_p
private

Definition at line 132 of file MSPolColumns.h.

Referenced by corrProduct(), and nrow().

◆ corrType_p

ArrayColumn<Int> casacore::MSPolarizationColumns::corrType_p
private

Definition at line 133 of file MSPolColumns.h.

Referenced by corrType().

◆ flagRow_p

ScalarColumn<Bool> casacore::MSPolarizationColumns::flagRow_p
private

Definition at line 134 of file MSPolColumns.h.

Referenced by flagRow().

◆ numCorr_p

ScalarColumn<Int> casacore::MSPolarizationColumns::numCorr_p
private

Definition at line 135 of file MSPolColumns.h.

Referenced by numCorr().


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