ConstMirPolSetup Class Reference

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

#include <FillMetadata.h>

Inheritance diagram for ConstMirPolSetup:

List of all members.

Public Member Functions
virtual	~ConstMirPolSetup ()
uInt	getCorrCount ()
	return the number of polarization correlation types in this setup
Bool	setCorr (Int poltype)
	set the current polarization correlation to the given type.
Bool	hasCorr (Int poltype)
	return True if the given polarization correlation type is a member of this set
void	clearIDs ()
	clear all the IDs associated with the polarization correlation types in this list
const List< MirPolCorr > &	getCorrs ()
	return the list of polarization correlation types stored in this set
MirPolCorr &	getCurrent ()
	return the currently selected polarization
Stokes::StokesTypes	getCurrentAipsType ()
	return the AIPS type for the current polarization.
Protected Member Functions
	ConstMirPolSetup ()
	ConstMirPolSetup (ConstMirPolSetup &other)
Bool	find (Int poltype, ConstListIter< MirPolCorr > &li)
Protected Attributes
List< MirPolCorr >	corrs
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 415 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 449 of file FillMetadata.h.

References corrs.

Bool ConstMirPolSetup::find	(	Int	poltype,
		ConstListIter< MirPolCorr > &	li
	)			[protected]

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

uInt ConstMirPolSetup::getCorrCount

(

)

[inline]

return the number of polarization correlation types in this setup

Definition at line 430 of file FillMetadata.h.

References corrs.

const List<MirPolCorr>& ConstMirPolSetup::getCorrs

(

)

[inline]

return the list of polarization correlation types stored in this set

Definition at line 457 of file FillMetadata.h.

References corrs.

Referenced by MirPolRecps::addPolsFor().

MirPolCorr& ConstMirPolSetup::getCurrent

(

)

[inline]

return the currently selected polarization

Definition at line 460 of file FillMetadata.h.

References iter.

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

References iter.

Bool ConstMirPolSetup::hasCorr

(

Int

poltype

)

[inline]

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

Definition at line 442 of file FillMetadata.h.

References corrs, and find().

Bool ConstMirPolSetup::setCorr

(

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

Reimplemented in MirPolSetup.

Definition at line 435 of file FillMetadata.h.

References find(), and iter.

---

Member Data Documentation

List<MirPolCorr> ConstMirPolSetup::corrs [protected]

Definition at line 420 of file FillMetadata.h.

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

ListIter<MirPolCorr> ConstMirPolSetup::iter [protected]

Definition at line 421 of file FillMetadata.h.

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

---

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

• code/miriad/Filling/FillMetadata.h