Go to the documentation of this file.
28 #ifndef LATTICES_LATTICENAVIGATOR_H
29 #define LATTICES_LATTICENAVIGATOR_H
33 #include <casacore/casa/aips.h>
39 class ROTiledStManAccessor;
340 uInt maxCacheSize,
uInt bucketSize)
const = 0;
virtual uInt nsteps() const =0
Function to return the number of steps (increments or decrements) taken since construction (or since ...
virtual IPosition trc() const
A Vector of integers, for indexing into Array<T> objects.
virtual IPosition blc() const
Return the bottom left hand corner (blc), top right corner (trc) or step size (increment) used by the...
LatticeNavigator()
Default constructor.
virtual Bool operator++(int)=0
Increment operator - increment the cursor to the next position.
virtual const IPosition & axisPath() const =0
Return the axis path.
virtual uInt calcCacheSize(const IPosition &cubeShape, const IPosition &tileShape, uInt maxCacheSize, uInt bucketSize) const =0
Calculate the cache size (in tiles) for this type of access to a lattice in the given row of the tile...
virtual IPosition cursorShape() const =0
Function which returns the current shape of the cursor which is iterating through the Lattice.
virtual LatticeNavigator * clone() const =0
Function which returns a pointer to dynamic memory of an exact copy of this LatticeNavigator.
virtual Bool operator--(int)=0
Decrement operator - decrement the cursor to the previous position.
virtual void subSection(const IPosition &blc, const IPosition &trc, const IPosition &inc)
virtual IPosition latticeShape() const =0
Functions which return the shape of the Lattice being iterated through.
Abstract base class to steer lattice iterators.
virtual IPosition endPosition() const =0
Functions which return the current position of the end of the cursor.
virtual void subSection(const IPosition &blc, const IPosition &trc)
Function to specify a "section" of the Lattice to Navigate over.
virtual IPosition position() const =0
Functions which return the current position of the beginning of the cursor.
virtual IPosition relativeEndPosition() const
virtual IPosition increment() const
this file contains all the compiler specific defines
virtual IPosition subLatticeShape() const
virtual Bool ok() const
Function which checks the internals of the class for consistency.
virtual IPosition hangOverBlc() const
Functions which return the "bottom left corner" and the "top right corner" of the cursor that does no...
virtual ~LatticeNavigator()
A virtual destructor.
virtual IPosition relativePosition() const
LatticeNavigator & operator=(const LatticeNavigator &)
Assignment.
virtual Bool atEnd() const =0
Function which returns "True" if an attempt has been made to increment the cursor beyond the end of t...
virtual Bool hangOver() const =0
Function which returns "True" if the increment/decrement operators have moved the cursor position suc...
virtual IPosition cursorAxes() const =0
Function which returns the axes of the cursor.
virtual Bool atStart() const =0
Function which returns "True" if the cursor is at the beginning of the Lattice, otherwise,...
bool Bool
Define the standard types used by Casacore.
virtual IPosition hangOverTrc() const
virtual void reset()=0
Function to reset the cursor to the beginning of the Lattice and reset the number of steps taken to z...
LatticeNavigator(const LatticeNavigator &)
Copy constructor.