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 ()

casacore::Bool	setCorr (casacore::Int poltype)
	set the current polarization correlation to the given type. More...

Public Member Functions inherited from ConstMirPolSetup
virtual	~ConstMirPolSetup ()

casacore::uInt	getCorrCount ()
	return the number of polarization correlation types in this setup More...

casacore::Bool	setCorr (casacore::Int poltype)
	set the current polarization correlation to the given type. More...

casacore::Bool	hasCorr (casacore::Int poltype)
	return true if the given polarization correlation type is a member of this set More...

void	clearIDs ()
	clear all the IDs associated with the polarization correlation types in this list More...

const casacore::List < MirPolCorr > &	getCorrs ()
	return the list of polarization correlation types stored in this set More...

MirPolCorr &	getCurrent ()
	return the currently selected polarization More...

casacore::Stokes::StokesTypes	getCurrentAipsType ()
	return the AIPS type for the current polarization. More...

Public Member Functions inherited from MirInfo
	MirInfo ()

virtual	~MirInfo ()

Private Member Functions
void	addCorr (casacore::Int poltype)
	add a new correlation type to this list. More...

Additional Inherited Members
Protected Member Functions inherited from ConstMirPolSetup
	ConstMirPolSetup ()

	ConstMirPolSetup (ConstMirPolSetup &other)

casacore::Bool	find (casacore::Int poltype, casacore::ConstListIter< MirPolCorr > &li)

Protected Attributes inherited from ConstMirPolSetup
casacore::List< MirPolCorr >	corrs

casacore::ListIter< MirPolCorr >	iter

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 498 of file FillMetadata.h.

Constructor & Destructor Documentation

MirPolSetup::MirPolSetup ( )

MirPolSetup::MirPolSetup ( ConstMirPolSetup & other )

virtual MirPolSetup::~MirPolSetup ( )

virtual

Member Function Documentation

void MirPolSetup::addCorr ( casacore::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().

casacore::Bool MirPolSetup::setCorr ( casacore::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.

Definition at line 512 of file FillMetadata.h.

References addCorr(), ConstMirPolSetup::find(), and ConstMirPolSetup::iter.

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

casa/code/miriad/Filling/FillMetadata.h

Public Member Functions

Private Member Functions

Additional Inherited Members