class BoxIterator

BoxIterator iterates through the IntVects of a box

Inheritance:

public members:

Constructors, destructors, defines

BoxIterator ()

BoxIterator(const Box & bx)

void define (const Box & bx)

BoxIterator (const BoxIterator & tx)

~BoxIterator ()

Modification functions

void begin()

void next()

Access functions

const IntVect & operator() () const

bool ok()

BoxIterator ()

Default constructor. This constructs an invalid iterator. The user must call define before using.

BoxIterator (const Box & bx)

constructor Arguments: bx (not modified) the box to iterate over Returns: none. This: This object is modified.

void define (const Box & bx)

Define which box is associated with this iterator. Arguments: bx (not modified) is the box to iterate over Returns: none. This: This object is modified.

BoxIterator (const BoxIterator & tx)

copy constructor Arguments: tx (not modified) is another BoxIterator. Returns: none. This: This object is modified.

~BoxIterator ()

Default destructor.

void begin ()

Sets the iterator to the first intvect. Arguments: none. Returns: none. This: This object is modified.

void next ()

Advances the iterator to the next intvect. Arguments: none. Returns: none. This: This object is modified.

const IntVect & operator() () const

Returns the value of the invect for the current iteration. Arguments: none. Returns: Returns the value of the intvect for the current iteration. This: This object is not modified.

bool ok ()

Checks to see if there is a next intvect. Arguments: none. Returns: true if there is another intvect in the box; false otherwise. This: This object is not modified.

this page has been generated automatically by doc++