casa::RFCubeLatticeIterator< T > Class Template Reference
[Flagging_internal_classes]

#include <RFCubeLattice.h>

Inheritance diagram for casa::RFCubeLatticeIterator< T >:

[legend]Collaboration diagram for casa::RFCubeLatticeIterator< T >:

[legend]List of all members.

---

Detailed Description

template<class T>
class casa::RFCubeLatticeIterator< T >

RFCubeLatticeIterator: iterator over a cubic lattice.

Intended use:

Internal

Prerequisite

• LatticeIterator

Synopsis

See RFCubeLattice, below

Template Type Argument Requirements (T)

• same as LatticeIterator

To Do

• add this feature
• fix this bug
• start discussion of this possible extension

Definition at line 63 of file RFCubeLattice.h.

Public Member Functions
	RFCubeLatticeIterator ()
	default constructor creates empty iterator
	RFCubeLatticeIterator (TempLattice< T > &lat, const IPosition &iter_shape)
	creates and attches to lattice
	~RFCubeLatticeIterator ()
	destructor
Matrix< T > *	reset (Bool will_read=True, Bool will_write=True)
	resets the lattice iterator to beginning, returns cursor
void	setRead (Bool val=True)
	enables or diables read/write access
void	setWrite (Bool val=True)
Matrix< T > *	advance (Int iz)
	advances internal iterator to specified slot along the Z axis, returns cursor
Int	position ()
	returns position of internal iterator
Matrix< T > *	cursor ()
	returns internal cursor
T &	operator() (uInt i, uInt j)
	returns element at i,j of cursor
Protected Member Functions
Matrix< T > *	setupCursor ()
Protected Attributes
Bool	read
Bool	write
Int	iter_pos
Matrix< T > *	curs

---

Constructor & Destructor Documentation

template<class T>

casa::RFCubeLatticeIterator< T >::RFCubeLatticeIterator

(

)

default constructor creates empty iterator

template<class T>

casa::RFCubeLatticeIterator< T >::RFCubeLatticeIterator	(	TempLattice< T > &	lat,
		const IPosition &	iter_shape
	)

creates and attches to lattice

template<class T>

casa::RFCubeLatticeIterator< T >::~RFCubeLatticeIterator

(

)

destructor

---

Member Function Documentation

template<class T>

Matrix<T>* casa::RFCubeLatticeIterator< T >::setupCursor

(

)

[protected]

template<class T>

Matrix<T>* casa::RFCubeLatticeIterator< T >::reset	(	Bool	will_read = True,
		Bool	will_write = True
	)

resets the lattice iterator to beginning, returns cursor

template<class T>

void casa::RFCubeLatticeIterator< T >::setRead

(

Bool

val = True

)

[inline]

enables or diables read/write access

Definition at line 90 of file RFCubeLattice.h.

template<class T>

void casa::RFCubeLatticeIterator< T >::setWrite

(

Bool

val = True

)

[inline]

Definition at line 92 of file RFCubeLattice.h.

template<class T>

Matrix<T>* casa::RFCubeLatticeIterator< T >::advance

(

Int

iz

)

advances internal iterator to specified slot along the Z axis, returns cursor

template<class T>

Int casa::RFCubeLatticeIterator< T >::position

(

)

[inline]

returns position of internal iterator

Definition at line 99 of file RFCubeLattice.h.

template<class T>

Matrix<T>* casa::RFCubeLatticeIterator< T >::cursor

(

)

[inline]

returns internal cursor

Definition at line 103 of file RFCubeLattice.h.

Referenced by casa::RFFlagCube::getFlag().

template<class T>

T& casa::RFCubeLatticeIterator< T >::operator()	(	uInt	i,
		uInt	j
	)			[inline]

returns element at i,j of cursor

Definition at line 107 of file RFCubeLattice.h.

---

Member Data Documentation

template<class T>

Bool casa::RFCubeLatticeIterator< T >::read [protected]

Definition at line 72 of file RFCubeLattice.h.

Referenced by casa::RFCubeLatticeIterator< uInt >::setRead().

template<class T>

Bool casa::RFCubeLatticeIterator< T >::write [protected]

Definition at line 72 of file RFCubeLattice.h.

Referenced by casa::RFCubeLatticeIterator< uInt >::setWrite().

template<class T>

Int casa::RFCubeLatticeIterator< T >::iter_pos [protected]

Definition at line 73 of file RFCubeLattice.h.

Referenced by casa::RFCubeLatticeIterator< uInt >::position().

template<class T>

Matrix<T>* casa::RFCubeLatticeIterator< T >::curs [protected]

Definition at line 74 of file RFCubeLattice.h.

Referenced by casa::RFCubeLatticeIterator< uInt >::cursor(), and casa::RFCubeLatticeIterator< uInt >::operator()().

---

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

• flagging/implement/Flagging/RFCubeLattice.h

---