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

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

Inheritance diagram for Dune::EntityIterator< codim, Grid, IteratorImp >:

List of all members.

Public Types
typedef Grid::template Codim < codim >::Entity	Entity
	The Entity that this EntityPointer can point to.
enum
	codimension of entity pointer More...
enum
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 Types
typedef IteratorImp	Implementation
Protected Member Functions
Implementation &	impl ()
	return reference to the real implementation
const Implementation &	impl () const
	return reference to the real implementation
Protected Attributes
Implementation	realIterator
Friends
class	Dune::GenericLeafIterator< GridImp >
class	GridDefaultImplementation< GridImp::dimension, GridImp::dimensionworld, typename GridImp::ctype, typename GridImp::GridFamily >

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

Member Typedef Documentation

template<int codim, class Grid, class IteratorImp>

typedef Grid::template Codim< codim >::Entity Dune::EntityIterator< codim, Grid, IteratorImp >::Entity

The Entity that this EntityPointer can point to.

Reimplemented from Dune::EntityPointer< Grid, IteratorImp >.

typedef IteratorImp Dune::EntityPointer< Grid , IteratorImp >::Implementation [protected, inherited]

Member Enumeration Documentation

anonymous enum [inherited]

codimension of entity pointer

anonymous enum [inherited]

Constructor & Destructor Documentation

template<int codim, class Grid, class IteratorImp>

Dune::EntityIterator< codim, Grid, IteratorImp >::EntityIterator ( const IteratorImp & imp ) [inline]

copy constructor from implementaton

Member Function Documentation

bool Dune::EntityPointer< Grid , IteratorImp >::equals ( const EntityPointer< Grid , ItImp > & rhs ) const [inline, inherited]

Forward equality check to realIterator.

Implementation& Dune::EntityPointer< Grid , IteratorImp >::impl ( ) [inline, protected, inherited]

return reference to the real implementation

const Implementation& Dune::EntityPointer< Grid , IteratorImp >::impl ( ) const [inline, protected, inherited]

return reference to the real implementation

int Dune::EntityPointer< Grid , IteratorImp >::level ( ) const [inline, inherited]

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.

bool Dune::EntityPointer< Grid , IteratorImp >::operator!= ( const EntityPointer< Grid , ItImp > & rhs ) const [inline, inherited]

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.

Entity& Dune::EntityPointer< Grid , IteratorImp >::operator* ( ) const [inline, inherited]

Dereferencing operator.

template<int codim, class Grid, class IteratorImp>

EntityIterator& Dune::EntityIterator< codim, Grid, IteratorImp >::operator++ ( ) [inline]

prefix increment operator

Reimplemented in Dune::HierarchicIterator< GridImp, HierarchicIteratorImp >, Dune::LevelIterator< codim, pitype, GridImp, LevelIteratorImp >, and Dune::LeafIterator< codim, pitype, GridImp, LeafIteratorImp >.

Entity* Dune::EntityPointer< Grid , IteratorImp >::operator-> ( ) const [inline, inherited]

Pointer operator.

bool Dune::EntityPointer< Grid , IteratorImp >::operator== ( const EntityPointer< Grid , ItImp > & rhs ) const [inline, inherited]

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.

Friends And Related Function Documentation

friend class Dune::GenericLeafIterator< Grid > [friend, inherited]

friend class GridDefaultImplementation< Grid ::dimension, Grid ::dimensionworld,typename Grid ::ctype,typename Grid ::GridFamily > [friend, inherited]