MirPolSetup Class Reference

an editable container for a set of Miriad polarization correlation types More...

#include <FillMetadata.h>

Inheritance diagram for MirPolSetup:

Public Member Functions
	MirPolSetup ()
	MirPolSetup (ConstMirPolSetup &other)
virtual	~MirPolSetup ()
Bool	setCorr (Int poltype)
	set the current polarization correlation to the given type.
Private Member Functions
void	addCorr (Int poltype)
	add a new correlation type to this list.

Detailed Description

an editable container for a set of Miriad polarization correlation types

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

the name is short for Miriad Polarization Setup.

Synopsis

This class contains a list of polarization cross-correlation combinations. This version allows new values to be added to the list.

Motivation

Miriad datasets record different polarization measurements in seperate records; thus, there is a notion of a current polarization among several being read. Furthermore, you usually don't know which polarizations are in the dataset until you've read at least one record with each kind of polarization. You do usually know the total number of different polarizations after reading the first record.

Definition at line 497 of file FillMetadata.h.

Constructor & Destructor Documentation

MirPolSetup::MirPolSetup ( )

MirPolSetup::MirPolSetup ( ConstMirPolSetup & other )

virtual MirPolSetup::~MirPolSetup ( ) [virtual]

Member Function Documentation

void MirPolSetup::addCorr ( Int poltype ) [private]

add a new correlation type to this list.

This function assumes that the type does not already exist in the list.

Referenced by setCorr().

Bool MirPolSetup::setCorr ( Int poltype ) [inline]

set the current polarization correlation to the given type.

If the type is not already part of this set, it will be added. True is returned if the type is found without having to add it.

Reimplemented from ConstMirPolSetup.

Definition at line 511 of file FillMetadata.h.

References addCorr(), casacore::False, ConstMirPolSetup::find(), ConstMirPolSetup::iter, and casacore::True.

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

code/miriad/Filling/FillMetadata.h