AbstractCellPopulation< DIM >::Iterator Class Reference

#include <AbstractCellPopulation.hpp>

Collaboration diagram for AbstractCellPopulation< DIM >::Iterator:

Collaboration graph
[legend]

List of all members.

Public Member Functions

CellPtr operator* ()
CellPtr operator-> ()
bool operator!= (const AbstractCellPopulation< DIM >::Iterator &rOther)
Iteratoroperator++ ()
 Iterator (AbstractCellPopulation &rCellPopulation, std::list< CellPtr >::iterator cellIter)
virtual ~Iterator ()

Private Member Functions

virtual bool IsRealCell ()
bool IsAtEnd ()

Private Attributes

AbstractCellPopulationmrCellPopulation
std::list< CellPtr >::iterator mCellIter


Detailed Description

template<unsigned DIM>
class AbstractCellPopulation< 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 672 of file AbstractCellPopulation.hpp.


Constructor & Destructor Documentation

template<unsigned DIM>
AbstractCellPopulation< 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 810 of file AbstractCellPopulation.hpp.

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

template<unsigned DIM>
virtual AbstractCellPopulation< DIM >::Iterator::~Iterator (  )  [inline, virtual]

The iterator must have a virtual destructor.

Definition at line 710 of file AbstractCellPopulation.hpp.


Member Function Documentation

template<unsigned DIM>
CellPtr AbstractCellPopulation< DIM >::Iterator::operator* (  )  [inline]

Dereference the iterator giving you a pointer to the current cell.

Definition at line 766 of file AbstractCellPopulation.hpp.

template<unsigned DIM>
CellPtr AbstractCellPopulation< DIM >::Iterator::operator-> (  )  [inline]

Unusually for an iterator over a collection of pointers, this method allows you to access the object pointed at, rather than the pointer itself.

Definition at line 773 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< DIM >::Iterator::IsAtEnd(), and AbstractCellPopulation< DIM >::Iterator::mCellIter.

template<unsigned DIM>
bool AbstractCellPopulation< DIM >::Iterator::operator!= ( const AbstractCellPopulation< DIM >::Iterator rOther  )  [inline]

Comparison not-equal-to.

Parameters:
rOther iterator with which comparison is made

Definition at line 780 of file AbstractCellPopulation.hpp.

References AbstractCellPopulation< DIM >::Iterator::mCellIter.

template<unsigned DIM>
AbstractCellPopulation< DIM >::Iterator & AbstractCellPopulation< DIM >::Iterator::operator++ (  )  [inline]

template<unsigned DIM>
bool AbstractCellPopulation< DIM >::Iterator::IsRealCell (  )  [inline, private, virtual]

Private helper function which tells us if 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 798 of file AbstractCellPopulation.hpp.

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

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

template<unsigned DIM>
bool AbstractCellPopulation< DIM >::Iterator::IsAtEnd (  )  [inline, private]


Member Data Documentation

template<unsigned DIM>
std::list<CellPtr>::iterator AbstractCellPopulation< DIM >::Iterator::mCellIter [private]


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

Generated on Tue May 31 14:32:06 2011 for Chaste by  doxygen 1.5.5