---

BoxIterator Class Reference

iterates through the IntVects of a Box More...

#include <BoxIterator.H>

Collaboration diagram for BoxIterator:

[legend]List of all members.

Public Methods
	BoxIterator ()
	{\bf Constructors, destructors, defines}
	BoxIterator (const Box &bx)
void	setBox (const Box &bx)
void	define (const Box &bx)
	BoxIterator (const BoxIterator &tx)
	~BoxIterator ()
void	begin ()
	{\bf Modification functions}
void	reset ()
void	operator++ ()
void	next ()
const IntVect &	operator() () const
bool	ok ()
Protected Attributes
Box	box_ptr
Tuple< int, SpaceDim >	nx
Tuple< int, SpaceDim >	iloc
Tuple< int, SpaceDim >	len
IntVect	current
IntVect	offset
int	icur

---

Detailed Description

iterates through the IntVects of a Box

BoxIterator iterates through the IntVects of a box. The actual sqeuence of IntVects is implementation-specific. Typical usage:\

\begin{verbatim} Box b; ... BoxIterator bit (b); for (bit.begin(); bit.ok(); ++bit) { IntVect iv = bit(); (do operations involving iv) } \end{verbatim}

---

Constructor & Destructor Documentation

BoxIterator::BoxIterator (    )  [inline]

{\bf Constructors, destructors, defines} Default constructor. This constructs an invalid iterator. The user must call define before using.

BoxIterator::BoxIterator (  const Box &    bx )  [inline]

Constructs a BoxIterator and associates it with a Box.\ {\bf Arguments:}\ bx (not modified) the Box to iterate over.\ {\bf Returns:} none.\ {\bf This:}\ This object is modified.

BoxIterator::BoxIterator (  const BoxIterator &    tx )  [inline]

Copy constructor.\ {\bf Arguments:}\ tx (not modified) the BoxIterator to copy.\ {\bf Returns:} none.\ {\bf This:}\ This object is modified.

BoxIterator::~BoxIterator (    )  [inline]

Destructor.

---

Member Function Documentation

void BoxIterator::begin (    )  [inline]

{\bf Modification functions} Sets this BoxIterator to the first IntVect in its Box. The definition of the "first" IntVect is implementation-dependent.\ {\bf Arguments:} none.\ {\bf Returns:} none.\ {\bf This:}\ This object is modified.

void BoxIterator::define (  const Box &    bx )  [inline]

Associates a Box with this BoxIterator.\ {\bf Arguments:}\ bx (not modified) the Box to iterate over. \ {\bf Returns:} none.\ {\bf This:}\ This object is modified.

void BoxIterator::next (    )  [inline]

bool BoxIterator::ok (    )  [inline]

Returns true if this BoxIterator's location is within its Box.\ {\bf Arguments:} none.\ {\bf Returns:} \ true if this BoxIterator's current location is in its Box.\ {\bf This:}\ This object is not modified.

const IntVect& BoxIterator::operator() (    )  const [inline]

Returns the value of the InVect for the current location of this BoxIterator.\ {\bf Arguments:} none.\ {\bf Returns:} \ the value of the intvect for the current location.\ {\bf This:}\ This object is not modified.

void BoxIterator::operator++ (    )  [inline]

Modifies this BoxIterator to set it to the next location in its Box. The definition of the "next location" of a Box is implementation-dependent.\ {\bf Arguments:} none. \ {\bf Returns:} none. \ {\bf This:} \This object is modified.

void BoxIterator::reset (    )  [inline]

Sets this BoxIterator to the first IntVect in its Box. The definition of the "first" IntVect is implementation-dependent.\ {\bf Arguments:} none.\ {\bf Returns:} none.\ {\bf This:}\ This object is modified.

void BoxIterator::setBox (  const Box &    bx )  [inline]

---

Member Data Documentation

Box BoxIterator::box_ptr [protected]

IntVect BoxIterator::current [protected]

int BoxIterator::icur [protected]

Tuple<int, SpaceDim> BoxIterator::iloc [protected]

Tuple<int, SpaceDim> BoxIterator::len [protected]

Tuple<int, SpaceDim> BoxIterator::nx [protected]

IntVect BoxIterator::offset [protected]

---

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

• BoxIterator.H

---