SAMRAI::pdat::IndexIterator< DIM, TYPE > Class Template Reference

#include <source/patchdata/index/IndexData.h>

List of all members.

Public Member Functions
	IndexIterator ()
	IndexIterator (IndexData< DIM, TYPE > &data)
	IndexIterator (const IndexIterator< DIM, TYPE > &iterator)
IndexIterator< DIM, TYPE > &	operator= (const IndexIterator< DIM, TYPE > &iterator)
	~IndexIterator ()
TYPE &	operator * ()
TYPE &	operator() ()
TYPE &	getItem ()
const hier::Index< DIM > &	getIndex () const
	operator bool () const
	operator const void * () const
bool	operator! () const
void	operator++ (int)
bool	operator== (const IndexIterator< DIM, TYPE > &iterator) const
bool	operator!= (const IndexIterator< DIM, TYPE > &iterator) const

---

Detailed Description

template<int DIM, class TYPE>
class SAMRAI::pdat::IndexIterator< DIM, TYPE >

Class IndexIterator is the iterator associated with the IndexData This class provides methods for stepping through the list that contains the irregular index set. The user should access this class through the name IndexData<DIM,TYPE>::Iterator.

This iterator should be used as follows:

   IndexData<DIM,TYPE> data;
   ...
   for (IndexData<DIM,TYPE>::Iterator iter(data); iter; iter++ {
      ... = iter();
   }
   

See also:

tbox::List

pdat::IndexData

pdat::IndexIterator

---

Constructor & Destructor Documentation

template<int DIM, class TYPE> SAMRAI::pdat::IndexIterator< DIM, TYPE >::IndexIterator (   )

Default constructor for the index list iterator. The iterator must be initialized before it can be used to iterate over an IndexData object.

template<int DIM, class TYPE> SAMRAI::pdat::IndexIterator< DIM, TYPE >::IndexIterator (  IndexData< DIM, TYPE > &  data  )

Constructor for the index list iterator. The iterator will iterate over the irregular index set of the argument data object.

template<int DIM, class TYPE> SAMRAI::pdat::IndexIterator< DIM, TYPE >::IndexIterator (  const IndexIterator< DIM, TYPE > &  iterator  )

Copy constructor for the index list iterator.

template<int DIM, class TYPE> SAMRAI::pdat::IndexIterator< DIM, TYPE >::~IndexIterator (   )  [inline]

Destructor for the index list iterator.

---

Member Function Documentation

template<int DIM, class TYPE> IndexIterator< DIM, TYPE > & SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator= (  const IndexIterator< DIM, TYPE > &  iterator  )  [inline]

Assignment operator for the index list iterator.

template<int DIM, class TYPE> TYPE & SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator * (   )  [inline]

Return the current item in the irregular index set.

template<int DIM, class TYPE> TYPE & SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator() (   )  [inline]

Return the current item in the irregular index set.

template<int DIM, class TYPE> TYPE & SAMRAI::pdat::IndexIterator< DIM, TYPE >::getItem (   )  [inline]

Return the current item in the irregular index set.

template<int DIM, class TYPE> const hier::Index< DIM > & SAMRAI::pdat::IndexIterator< DIM, TYPE >::getIndex (   )  const [inline]

Return the index of the current item in the irregular index set

template<int DIM, class TYPE> SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator bool (   )  const [inline]

Return true if the iterator points to a valid item in the index set.

template<int DIM, class TYPE> SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator const void * (   )  const [inline]

Return a non-null if the iterator points to a valid item in the index set.

template<int DIM, class TYPE> bool SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator! (   )  const [inline]

Return whether the iterator points to a valid item in the index set. This operator mimics the !p operation applied to a pointer p.

template<int DIM, class TYPE> void SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator++ (  int   )  [inline]

Increment the iterator to point to the next item in the index set.

template<int DIM, class TYPE> bool SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator== (  const IndexIterator< DIM, TYPE > &  iterator  )  const [inline]

Test two iterators for equality (pointing to the same item).

template<int DIM, class TYPE> bool SAMRAI::pdat::IndexIterator< DIM, TYPE >::operator!= (  const IndexIterator< DIM, TYPE > &  iterator  )  const [inline]

Test two iterators for inequality (pointing to different items).

---

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

• source/patchdata/index/IndexData.h
• source/patchdata/index/IndexData.C
• source/patchdata/index/IndexData.I

---