casa::CalIter Class Reference
[CalTables]

#include <CalIter.h>

Inheritance diagram for casa::CalIter:

[legend]Collaboration diagram for casa::CalIter:

[legend]List of all members.

---

Detailed Description

CalIter: Sequential calibration table iterator.

Intended use:

Part of API

Prerequisite

• CalTable module
• CalIterBase module

Etymology

From "calibration table" and "iterator"

Synopsis

The CalIter class is a sequential calibration table iterator, inherited from the abstract base class CalIterBase.

Example

Motivation

Encapsulate sequential calibration table iteration.

To Do

i) Deal with non-standard columns.

Definition at line 71 of file CalIter.h.

Public Member Functions
	CalIter (CalTable &calTable)
	Construct from a calibration table without specifying iteration indices and intervals.
	CalIter (CalTable &calTable, const Vector< Int > &iterIndices, Sort::Order order=Sort::Ascending, Sort::Option=Sort::HeapSort)
	Construct from a calibration table, set of iteration indices, iteration order and iteration sort option.
virtual	~CalIter ()
	Default destructor.
void	origin ()
	Iterator control.
Bool	more ()
virtual CalTable &	subTable ()
	Current iteration sub-table.
Protected Member Functions
	CalIter ()
	Prohibit public use of the null constructor, which does not produce a usable object.
Private Attributes
CalTable *	calTable_p
	Pointer to calibration table.

---

Constructor & Destructor Documentation

casa::CalIter::CalIter

(

CalTable &

calTable

)

Construct from a calibration table without specifying iteration indices and intervals.

This returns the input calibration table in its entirety for each iteration, in the original sort order.

casa::CalIter::CalIter	(	CalTable &	calTable,
		const Vector< Int > &	iterIndices,
		Sort::Order	order = Sort::Ascending,
		Sort::Option	= Sort::HeapSort
	)

Construct from a calibration table, set of iteration indices, iteration order and iteration sort option.

This returns the input calibration table in its entirety for each iteration, sorted on the specified iteration indices.

virtual casa::CalIter::~CalIter

(

)

[virtual]

Default destructor.

casa::CalIter::CalIter

(

)

[inline, protected]

Prohibit public use of the null constructor, which does not produce a usable object.

Definition at line 100 of file CalIter.h.

---

Member Function Documentation

void casa::CalIter::origin

(

)

[inline]

Iterator control.

Definition at line 91 of file CalIter.h.

Bool casa::CalIter::more

(

)

[inline]

Definition at line 92 of file CalIter.h.

References casa::True.

virtual CalTable& casa::CalIter::subTable

(

)

[virtual]

Current iteration sub-table.

Implements casa::CalIterBase.

---

Member Data Documentation

CalTable* casa::CalIter::calTable_p [private]

Pointer to calibration table.

Definition at line 100 of file CalIter.h.

---

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

• calibration/implement/CalTables/CalIter.h

---