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 (Int spwid=-1, Int polid=-1)
	~DataDescComponents ()
Int	getSpectralWindowID () const
	return the spectral window ID component
Int	getPolarizationID () const
	return the polarization ID component
Bool	operator== (const DataDescComponents &other) const
Bool	exists () const
Private Attributes
Int	spw
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 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 MS MAIN table: the spectral window ID and the polarization ID.

Motivation

Records in the MAIN 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 Map).

Definition at line 822 of file FillMetadata.h.

Constructor & Destructor Documentation

DataDescComponents::DataDescComponents	(	Int	spwid = `-1`,
		Int	polid = `-1`
	)			`[inline]`

Definition at line 827 of file FillMetadata.h.

DataDescComponents::~DataDescComponents ( ) [inline]

Definition at line 828 of file FillMetadata.h.

Member Function Documentation

Bool DataDescComponents::exists ( ) const [inline]

Definition at line 840 of file FillMetadata.h.

References pol, and spw.

Int DataDescComponents::getPolarizationID ( ) const [inline]

return the polarization ID component

Definition at line 834 of file FillMetadata.h.

References pol.

Int DataDescComponents::getSpectralWindowID ( ) const [inline]

return the spectral window ID component

Definition at line 831 of file FillMetadata.h.

References spw.

Bool DataDescComponents::operator== ( const DataDescComponents & other ) const [inline]

Definition at line 836 of file FillMetadata.h.

References pol, and spw.

Member Data Documentation

Int DataDescComponents::pol [private]

Definition at line 825 of file FillMetadata.h.

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

Int DataDescComponents::spw [private]

Definition at line 824 of file FillMetadata.h.

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

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

code/miriad/Filling/FillMetadata.h