CalIter.h

Classes

CalIter -- CalIter: Sequential calibration table iterator (full description)

class CalIter : public CalIterBase

Interface

Public Members

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

virtual ~CalIter()

void origin()

Bool more()

virtual CalTable& subTable()

Protected Members

CalIter()

Description

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.

Member Description

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.

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

Default destructor

void origin()

Iterator control

Bool more()

virtual CalTable& subTable()

Current iteration sub-table

CalIter()

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