DataDescComponents Class Reference

a pair of indicies identifying the spectral window and polarization ids that make up a data description ID More...

#include <FillMetadata.h>

Public Member Functions
	DataDescComponents (casacore::Int spwid=-1, casacore::Int polid=-1)
	~DataDescComponents ()
casacore::Int	getSpectralWindowID () const
	return the spectral window ID component More...
casacore::Int	getPolarizationID () const
	return the polarization ID component More...
casacore::Bool	operator== (const DataDescComponents &other) const
casacore::Bool	exists () const

Private Attributes
casacore::Int	spw
casacore::Int	pol

Detailed Description

a pair of indicies identifying the spectral window and polarization ids that make up a data description ID

Intended use:

Internal

Review Status

Date Reviewed:

yyyy/mm/dd

Etymology

The casacore::Data Description subtable record has two main components: a spectral window ID and a polarization ID.

Synopsis

This class holds two IDs that make up the "data description" of a record in an casacore::MS MAIN table: the spectral window ID and the polarization ID.

Motivation

Records in the MAIN casacore::MS table are linked to rows in the SPECTRAL_WINDOW and POLARIZATION subtables via a single DATA_DESC_ID; this class collects the indicies into those two subtables into a single class that can be linked to an ID in the DATA_DESCRIPTION subtable (via a casacore::Map).

Definition at line 823 of file FillMetadata.h.

Constructor & Destructor Documentation

DataDescComponents::DataDescComponents ( casacore::Int  spwid = -1, casacore::Int  polid = -1  )

inline

Definition at line 828 of file FillMetadata.h.

DataDescComponents::~DataDescComponents ( )

inline

Definition at line 829 of file FillMetadata.h.

Member Function Documentation

casacore::Bool DataDescComponents::exists ( ) const

inline

Definition at line 841 of file FillMetadata.h.

References pol, and spw.

casacore::Int DataDescComponents::getPolarizationID ( ) const

inline

return the polarization ID component

Definition at line 835 of file FillMetadata.h.

References pol.

casacore::Int DataDescComponents::getSpectralWindowID ( ) const

inline

return the spectral window ID component

Definition at line 832 of file FillMetadata.h.

References spw.

casacore::Bool DataDescComponents::operator== ( const DataDescComponents &  other ) const

inline

Definition at line 837 of file FillMetadata.h.

References pol, and spw.

Member Data Documentation

casacore::Int DataDescComponents::pol

private

Definition at line 826 of file FillMetadata.h.

Referenced by exists(), getPolarizationID(), and operator==().

casacore::Int DataDescComponents::spw

private

Definition at line 825 of file FillMetadata.h.

Referenced by exists(), getSpectralWindowID(), and operator==().

---

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

• casa/code/miriad/Filling/FillMetadata.h