Chombo + EB  3.0
Public Member Functions | Protected Member Functions | Friends | List of all members
DataIterator Class Reference

#include <DataIterator.H>

Inheritance diagram for DataIterator:
Inheritance graph
[legend]

Public Member Functions

virtual ~DataIterator ()
 
 DataIterator ()
 
 DataIterator (const BoxLayout &a_layout)
 
const DataIndexoperator() () const
 return the index that this iterator is at More...
 
DataIndex i () const
 return a copy of the index that this iterator is at More...
 
int size () const
 
- Public Member Functions inherited from LayoutIterator
 LayoutIterator ()
 a null constructed LayoutIterator will return false on ok() More...
 
virtual ~LayoutIterator ()
 
const LayoutIndexoperator() () const
 return the index that this iterator is at More...
 
LayoutIndex i () const
 return a copy of the index that this iterator is at More...
 
virtual void operator++ ()
 move the iterator to the next Box in the layout More...
 
void incr ()
 move the iterator to the next Box in the layout More...
 
virtual bool ok () const
 return true if this iterator is still in its Layout More...
 
void begin ()
 initialize this iterator to the first Box in its Layout More...
 
void reset ()
 same as begin() More...
 
void end ()
 move this iterator to after the last Box in the layout More...
 

Protected Member Functions

 DataIterator (const BoxLayout &boxlayout, const int *layoutID)
 
- Protected Member Functions inherited from LayoutIterator
 LayoutIterator (const BoxLayout &a_boxlayout, const int *a_layoutID)
 

Friends

class BoxLayout
 
class DisjointBoxLayout
 
class TimedDataIterator
 

Additional Inherited Members

- Protected Attributes inherited from LayoutIterator
BoxLayout m_layout
 
RefCountedPtr< Vector
< LayoutIndex > > 
m_indicies
 
int m_current
 

Constructor & Destructor Documentation

virtual DataIterator::~DataIterator ( )
inlinevirtual
DataIterator::DataIterator ( )
inline
DataIterator::DataIterator ( const BoxLayout a_layout)
inline
DataIterator::DataIterator ( const BoxLayout boxlayout,
const int *  layoutID 
)
inlineprotected

Member Function Documentation

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

return the index that this iterator is at

Aborts if the iterator is not ok()

References LayoutIterator::operator()().

Referenced by i().

DataIndex DataIterator::i ( ) const
inline

return a copy of the index that this iterator is at

Aborts if the iterator is not ok()

References operator()().

int DataIterator::size ( ) const
inline

Friends And Related Function Documentation

friend class BoxLayout
friend
friend class DisjointBoxLayout
friend
friend class TimedDataIterator
friend

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