---

DataIterator Class Reference

An Iterator based on a BoxLayout object. More...

#include <DataIterator.H>

Collaboration diagram for DataIterator:

[legend]List of all members.

Public Methods
	DataIterator ()
	a null constructed DataIterator will return false on ok()
	~DataIterator ()
const DataIndex &	operator() () const
DataIndex	i () const
void	operator++ ()
void	incr ()
bool	ok () const
void	reset ()
void	begin ()
void	end ()
Private Methods
	DataIterator (const BoxLayout &boxlayout, const int *layoutID)
Private Attributes
const BoxLayout	m_layout
unsigned int	m_index
DataIndex	m_current
unsigned int	m_procID
Friends
class	BoxLayout
class	DisjointBoxLayout

---

Detailed Description

An Iterator based on a BoxLayout object.

An Iterator based on a BoxLayout object. It does not support a dereferencing operation, since it is intended to work with all of BoxLayouts, DisjointBoxLayouts, BoxLayoutDatas LevelDatas, and any object that is built on top of a BoxLayout object. DataIterator access the data in a BoxLayout-based object in a data-parallel manner. Order is not defined.

---

Constructor & Destructor Documentation

DataIterator::DataIterator (    )  [inline]

a null constructed DataIterator will return false on ok()

DataIterator::~DataIterator (    )  [inline]

DataIterator::DataIterator (  const BoxLayout &    boxlayout, const int *    layoutID )  [private]

---

Member Function Documentation

void DataIterator::begin (    )  [inline]

void DataIterator::end (    )

skip the iterator to the end. ok() will return false after this method is called.

DataIndex DataIterator::i (    )  const [inline]

void DataIterator::incr (    )  [inline]

bool DataIterator::ok (    )  const [inline]

const DataIndex & DataIterator::operator() (    )  const [inline]

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

void DataIterator::reset (    )  [inline]

---

Friends And Related Function Documentation

friend class BoxLayout [friend]

friend class DisjointBoxLayout [friend]

---

Member Data Documentation

DataIndex DataIterator::m_current [private]

unsigned int DataIterator::m_index [private]

const BoxLayout DataIterator::m_layout [private]

unsigned int DataIterator::m_procID [private]

---

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

• DataIterator.H

---