AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator Class Reference

#include <AbstractCellPopulation.hpp>

Collaboration diagram for AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator:

Public Member Functions
CellPtr	operator* ()
CellPtr	operator-> ()
bool	operator!= (const typename AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator &rOther)
Iterator &	operator++ ()
	Iterator (AbstractCellPopulation &rCellPopulation, std::list< CellPtr >::iterator cellIter)
virtual	~Iterator ()
Private Member Functions
virtual bool	IsRealCell ()
bool	IsAtEnd ()
Private Attributes
AbstractCellPopulation &	mrCellPopulation
std::list< CellPtr >::iterator	mCellIter

Detailed Description

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>
class AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator

Iterator class allows one to iterate over cells in the cell population. Dereferencing the iterator will give you the current cell. There are also methods to get the node representing this cell, and the location of that node.

Definition at line 757 of file AbstractCellPopulation.hpp.

Constructor & Destructor Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::Iterator	(	AbstractCellPopulation &	rCellPopulation,
		std::list< CellPtr >::iterator	cellIter
	)			`[inline]`

Constructor for a new iterator.

Parameters:

	rCellPopulation	the cell population
	cellIter	iterator over list of cells

Definition at line 888 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::IsRealCell(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::mCellIter, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::mrCellPopulation, and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetCells().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM = ELEMENT_DIM>

virtual AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::~Iterator ( ) [inline, virtual]

The iterator must have a virtual destructor.

Definition at line 799 of file AbstractCellPopulation.hpp.

Member Function Documentation

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::IsAtEnd ( ) [inline, private]

Private helper function.

Returns:: whether we're at the end of the cells.

Definition at line 882 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::mCellIter, AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::mrCellPopulation, and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::rGetCells().

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::operator++(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::operator->().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::IsRealCell ( ) [inline, private, virtual]

Private helper function.

Returns:: whether we're pointing at a real cell. Assumes we are within range (i.e. not at End).

Real cells are not deleted.

Definition at line 876 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::IsCellAssociatedWithADeletedLocation(), AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::mCellIter, and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::mrCellPopulation.

Referenced by AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::Iterator(), and AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::operator++().

template<unsigned ELEMENT_DIM, unsigned SPACE_DIM>

bool AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator::operator!= ( const typename AbstractCellPopulation< ELEMENT_DIM, SPACE_DIM >::Iterator & rOther ) [inline]