ConstMirPolSetup Class Reference

a static container for a set of Miriad polarization correlation types More...

#include <FillMetadata.h>

Inheritance diagram for ConstMirPolSetup:

Public Member Functions
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 ()

Protected Member Functions
	ConstMirPolSetup ()
	ConstMirPolSetup (ConstMirPolSetup &other)
casacore::Bool	find (casacore::Int poltype, casacore::ConstListIter< MirPolCorr > &li)

Protected Attributes
casacore::List< MirPolCorr >	corrs
casacore::ListIter< MirPolCorr >	iter

Detailed Description

a static 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 Constant Miriad Polarization Setup.

Synopsis

This class contains a list of polarization cross-correlation combinations. New correlations cannot be added to this 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 416 of file FillMetadata.h.

Constructor & Destructor Documentation

virtual ConstMirPolSetup::~ConstMirPolSetup ( )

virtual

ConstMirPolSetup::ConstMirPolSetup ( )

protected

ConstMirPolSetup::ConstMirPolSetup ( ConstMirPolSetup &  other )

protected

Member Function Documentation

void ConstMirPolSetup::clearIDs ( )

inline

clear all the IDs associated with the polarization correlation types in this list

Definition at line 450 of file FillMetadata.h.

References casacore::ConstListIter< t >::atEnd(), MirPolCorr::clearID(), corrs, casacore::ConstListIter< t >::getRight(), and casacore::ConstListIter< t >::toStart().

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

protected

Referenced by hasCorr(), setCorr(), and MirPolSetup::setCorr().

casacore::uInt ConstMirPolSetup::getCorrCount ( )

inline

return the number of polarization correlation types in this setup

Definition at line 431 of file FillMetadata.h.

References corrs, and casacore::List< t >::len().

const casacore::List<MirPolCorr>& ConstMirPolSetup::getCorrs ( )

inline

return the list of polarization correlation types stored in this set

Definition at line 458 of file FillMetadata.h.

References corrs.

Referenced by MirPolRecps::addPolsFor().

MirPolCorr& ConstMirPolSetup::getCurrent ( )

inline

return the currently selected polarization

Definition at line 461 of file FillMetadata.h.

References casacore::ListIter< t >::getRight(), and iter.

casacore::Stokes::StokesTypes ConstMirPolSetup::getCurrentAipsType ( )

inline

return the AIPS type for the current polarization.

If no current polarization correlation type is set, YY is returned

Definition at line 465 of file FillMetadata.h.

References casacore::ConstListIter< t >::atEnd(), MirPolCorr::getAipsType(), casacore::ListIter< t >::getRight(), iter, and casacore::Stokes::YY.

casacore::Bool ConstMirPolSetup::hasCorr ( casacore::Int  poltype )

inline

return true if the given polarization correlation type is a member of this set

Definition at line 443 of file FillMetadata.h.

References corrs, and find().

casacore::Bool ConstMirPolSetup::setCorr ( casacore::Int  poltype )

inline

set the current polarization correlation to the given type.

true is returned if the type is found; if it is not, the current polarization is unchanged.

Note: this has been made non-virtual on purpose

Definition at line 436 of file FillMetadata.h.

References find(), and iter.

Member Data Documentation

casacore::List<MirPolCorr> ConstMirPolSetup::corrs

protected

Definition at line 421 of file FillMetadata.h.

Referenced by clearIDs(), getCorrCount(), getCorrs(), and hasCorr().

casacore::ListIter<MirPolCorr> ConstMirPolSetup::iter

protected

Definition at line 422 of file FillMetadata.h.

Referenced by getCurrent(), getCurrentAipsType(), setCorr(), and MirPolSetup::setCorr().

---

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

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