MBStencilIterator Class Reference

iterates through the MBStencilElements of a MBStencil. More...

#include <MBStencilIterator.H>

Public Member Functions
	MBStencilIterator ()
	MBStencilIterator (const MBStencil &a_stencil)
void	setStencil (const MBStencil &a_stencil)
void	define (const MBStencil &a_stencil)
	MBStencilIterator (const MBStencilIterator &a_iterIn)
	~MBStencilIterator ()
void	begin ()
void	reset ()
void	operator++ ()
void	next ()
const MBStencilElement &	operator() () const
bool	ok ()

Protected Attributes
MBStencil	m_stencil
int	m_indCurrent
int	m_indLo
int	m_indHi

Detailed Description

iterates through the MBStencilElements of a MBStencil.

MBStencilIterator iterates through the MBStencilElements of a MBStencil.

MBStencil stencil; ... MBStencilIterator sit(stencil); for (sit.begin(); sit.ok(); ++sit) { const MBStencilElement& stencilElement = sit(); (do operations involving stencilElement) }

Constructor & Destructor Documentation

MBStencilIterator() [1/3]

MBStencilIterator::MBStencilIterator ( )

inline

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

References m_indCurrent, m_indHi, and m_indLo.

MBStencilIterator() [2/3]

MBStencilIterator::MBStencilIterator ( const MBStencil &  a_stencil )

inline

Constructs a MBStencilIterator and associates it with a Box. Arguments: a_bx (not modified) the Box to iterate over.

References define().

MBStencilIterator() [3/3]

MBStencilIterator::MBStencilIterator ( const MBStencilIterator &  a_iterIn )

inline

Copy constructor. Arguments: a_iterIn (not modified) the MBStencilIterator to copy.

References m_indCurrent, m_indHi, m_indLo, and m_stencil.

~MBStencilIterator()

MBStencilIterator::~MBStencilIterator ( )

inline

References begin(), next(), ok(), operator()(), operator++(), and reset().

Member Function Documentation

setStencil()

void MBStencilIterator::setStencil

(

const MBStencil &

a_stencil

)

define()

void MBStencilIterator::define

(

const MBStencil &

a_stencil

)

Associates a MBStencil with this MBStencilIterator. Arguments: a_stencil (not modified) the MBStencil to iterate over.

Referenced by MBStencilIterator().

begin()

void MBStencilIterator::begin ( )

inline

Sets this MBStencilIterator to first MBStencilElement in its MBStencil.

References m_indCurrent, m_indHi, and m_indLo.

Referenced by reset(), and ~MBStencilIterator().

reset()

void MBStencilIterator::reset ( )

inline

Sets this MBStencilIterator to first MBStencilElement in its MBStencil.

References begin().

Referenced by ~MBStencilIterator().

operator++()

void MBStencilIterator::operator++ ( )

inline

Modifies this MBStencilIterator to set it to the next MBStencilElement in its MBStencil.

References next().

Referenced by ~MBStencilIterator().

next()

void MBStencilIterator::next ( )

inline

References m_indCurrent.

Referenced by operator++(), and ~MBStencilIterator().

operator()()

const MBStencilElement & MBStencilIterator::operator() ( ) const

inline

Returns the value of the MBStencilElement for the current location of this MBStencilIterator.

References CH_assert, m_indCurrent, m_indHi, m_indLo, and m_stencil.

Referenced by ~MBStencilIterator().

ok()

bool MBStencilIterator::ok ( )

inline

Returns true if this MBStencilIterator's location is within its MBStencil.

References m_indCurrent, and m_indHi.

Referenced by ~MBStencilIterator().

Member Data Documentation

m_stencil

MBStencil MBStencilIterator::m_stencil

protected

Referenced by MBStencilIterator(), and operator()().

m_indCurrent

int MBStencilIterator::m_indCurrent

protected

Referenced by begin(), MBStencilIterator(), next(), ok(), and operator()().

m_indLo

int MBStencilIterator::m_indLo

protected

Referenced by begin(), MBStencilIterator(), and operator()().

m_indHi

int MBStencilIterator::m_indHi

protected

Referenced by begin(), MBStencilIterator(), ok(), and operator()().

---

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

• MBStencilIterator.H