Dune::EntityIterator< codim, Grid, IteratorImp > Class Template Reference

interface class for an iterator over grid entities More...

#include <dune/grid/common/entityiterator.hh>

Public Types
enum
	codimension of entity pointer

Public Member Functions
EntityIterator &	operator++ ()
	prefix increment operator
Implementor's interface
	EntityIterator (const IteratorImp &imp)
	copy constructor from implementaton
Dereferencing
Entity &	operator* () const
	Dereferencing operator.
Entity *	operator-> () const
	Pointer operator.
Compare methods
bool	operator== (const EntityPointer< Grid, ItImp > &rhs) const
	Checks for equality. Only works for EntityPointers and iterators on the same grid. Due to the conversion operators one can compare all kinds of iterators and EntityPointer.
bool	operator!= (const EntityPointer< Grid, ItImp > &rhs) const
	Checks for inequality. Only works for EntityPointers and iterators on the same grid. Due to the conversion operators one can compare all kinds of iterators and EntityPointer.
Query methods
int	level () const
	Ask for level of entity. This method is redundant and is only there for efficiency reasons. It allows an implementation to return the level without actually constructing the entity.
Implementor interface
bool	equals (const EntityPointer< Grid, ItImp > &rhs) const
	Forward equality check to realIterator.

Protected Member Functions
Implementation &	impl ()
	return reference to the real implementation
const Implementation &	impl () const
	return reference to the real implementation

Detailed Description

template<int codim, class Grid, class IteratorImp>
class Dune::EntityIterator< codim, Grid, IteratorImp >

interface class for an iterator over grid entities

An entity iterator is an iterator over a subset of entities within a hierarchical grid. It is an extension of the Dune::EntityPointer interface.

Examples of entity iterators are:

• iterators over the leaf level (LeafGridView::Iterator)
• iterators over a grid level (LevelGridView::Iterator)
• iterators over the children of an entity (Grid::HierarchicIterator)

See also the documentation of Dune::EntityPointer.

Template Parameters

codim	codimension of entities this iterator walks over
Grid	type of the grid implementation
IteratorImp	type of the iterator implementation

---

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

• dune/grid/common/entityiterator.hh