coupling::interface::MoleculeIterator< LinkedCell, dim > Class Template Reference

some iterator scheme for traversing the molecules within a linked cell. More...

#include <MoleculeIterator.h>

Public Member Functions
	MoleculeIterator (LinkedCell &cell)
virtual	~MoleculeIterator ()
virtual void	begin ()=0
virtual bool	continueIteration () const =0
virtual void	next ()=0
virtual coupling::interface::Molecule< dim > &	get ()=0
virtual const coupling::interface::Molecule< dim > &	getConst ()=0

Protected Attributes
LinkedCell &	_cell

Detailed Description

template<class LinkedCell, unsigned int dim>
class coupling::interface::MoleculeIterator< LinkedCell, dim >

some iterator scheme for traversing the molecules within a linked cell.

This class provides some iterator scheme for traversing the molecules within a linked cell.

Template Parameters

LinkedCell	cell type
dim	Number of dimensions; it can be 1, 2 or 3

Author

Philipp Neumann

Constructor & Destructor Documentation

MoleculeIterator()

template<class LinkedCell, unsigned int dim>

coupling::interface::MoleculeIterator< LinkedCell, dim >::MoleculeIterator ( LinkedCell & cell )

inline

Constructor

~MoleculeIterator()

template<class LinkedCell, unsigned int dim>

virtual coupling::interface::MoleculeIterator< LinkedCell, dim >::~MoleculeIterator ( )

inlinevirtual

Destructor

Member Function Documentation

begin()

template<class LinkedCell, unsigned int dim>

virtual void coupling::interface::MoleculeIterator< LinkedCell, dim >::begin ( )

pure virtual

sets the iterator to the first element

continueIteration()

template<class LinkedCell, unsigned int dim>

virtual bool coupling::interface::MoleculeIterator< LinkedCell, dim >::continueIteration ( ) const

pure virtual

Returns

true, if the iterator should continue the molecule traversal, false otherwise.

get()

template<class LinkedCell, unsigned int dim>

virtual coupling::interface::Molecule< dim > & coupling::interface::MoleculeIterator< LinkedCell, dim >::get ( )

pure virtual

Returns

a reference to the molecule that this iterator currently points to

getConst()

template<class LinkedCell, unsigned int dim>

virtual const coupling::interface::Molecule< dim > & coupling::interface::MoleculeIterator< LinkedCell, dim >::getConst ( )

pure virtual

Returns

a const reference to the current molecule for pure reading purposes

next()

template<class LinkedCell, unsigned int dim>

virtual void coupling::interface::MoleculeIterator< LinkedCell, dim >::next ( )

pure virtual

sets the iterator to the next molecule

---

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

• coupling/interface/MoleculeIterator.h