PottsMesh< DIM >::PottsElementIterator Class Reference
#include <PottsMesh.hpp>
Public Member Functions | |
| PottsElement< DIM > & | operator* () |
| PottsElement< DIM > * | operator-> () |
| bool | operator!= (const PottsMesh< DIM >::PottsElementIterator &rOther) |
| PottsElementIterator & | operator++ () |
| PottsElementIterator (PottsMesh< DIM > &rMesh, typename std::vector< PottsElement< DIM > * >::iterator elementIter, bool skipDeletedElements=true) | |
Private Member Functions | |
| bool | IsAtEnd () |
| bool | IsAllowedElement () |
Private Attributes | |
| PottsMesh< DIM > & | mrMesh |
| std::vector< PottsElement< DIM > * >::iterator | mElementIter |
| bool | mSkipDeletedElements |
Detailed Description
template<unsigned DIM>
class PottsMesh< DIM >::PottsElementIterator
A smart iterator over the elements in the mesh.
- Todo:
- This is the same as in AbstractTetrahedralMesh and VertexMesh- merge? (#1379)
Definition at line 331 of file PottsMesh.hpp.
Constructor & Destructor Documentation
| PottsMesh< DIM >::PottsElementIterator::PottsElementIterator | ( | PottsMesh< DIM > & | rMesh, | |
| typename std::vector< PottsElement< DIM > * >::iterator | elementIter, | |||
| bool | skipDeletedElements = true | |||
| ) | [inline] |
Constructor for a new iterator.
This should not be called directly by user code; use the mesh methods PottsMesh::GetElementIteratorBegin and PottsMesh::GetElementIteratorEnd instead.
- Parameters:
-
rMesh the mesh to iterator over elementIter where to start iterating skipDeletedElements whether to include deleted elements (defaults to true)
Definition at line 446 of file PottsMesh.hpp.
References PottsMesh< DIM >::PottsElementIterator::IsAllowedElement(), PottsMesh< DIM >::PottsElementIterator::mElementIter, and PottsMesh< DIM >::PottsElementIterator::mrMesh.
Member Function Documentation
| bool PottsMesh< DIM >::PottsElementIterator::IsAllowedElement | ( | ) | [inline, private] |
Helper method to say if we're allowed to point at this element.
Definition at line 476 of file PottsMesh.hpp.
References PottsMesh< DIM >::PottsElementIterator::mSkipDeletedElements.
Referenced by PottsMesh< DIM >::PottsElementIterator::operator++(), and PottsMesh< DIM >::PottsElementIterator::PottsElementIterator().
Helper method to say when we're at the end.
Definition at line 470 of file PottsMesh.hpp.
References PottsMesh< DIM >::PottsElementIterator::mElementIter, and PottsMesh< DIM >::PottsElementIterator::mrMesh.
Referenced by PottsMesh< DIM >::PottsElementIterator::operator*(), PottsMesh< DIM >::PottsElementIterator::operator++(), and PottsMesh< DIM >::PottsElementIterator::operator->().
| bool PottsMesh< DIM >::PottsElementIterator::operator!= | ( | const PottsMesh< DIM >::PottsElementIterator & | rOther | ) | [inline] |
Comparison not-equal-to.
- Parameters:
-
rOther iterator with which comparison is made
Definition at line 428 of file PottsMesh.hpp.
References PottsMesh< DIM >::PottsElementIterator::mElementIter.
| PottsElement< DIM > & PottsMesh< DIM >::PottsElementIterator::operator* | ( | ) | [inline] |
Dereference the iterator giving you a *reference* to the current element.
Make sure to use a reference for the result to avoid copying elements unnecessarily.
Definition at line 414 of file PottsMesh.hpp.
References PottsMesh< DIM >::PottsElementIterator::IsAtEnd(), and PottsMesh< DIM >::PottsElementIterator::mElementIter.
| PottsMesh< DIM >::PottsElementIterator & PottsMesh< DIM >::PottsElementIterator::operator++ | ( | ) | [inline] |
Prefix increment operator.
Definition at line 434 of file PottsMesh.hpp.
References PottsMesh< DIM >::PottsElementIterator::IsAllowedElement(), PottsMesh< DIM >::PottsElementIterator::IsAtEnd(), and PottsMesh< DIM >::PottsElementIterator::mElementIter.
| PottsElement< DIM > * PottsMesh< DIM >::PottsElementIterator::operator-> | ( | ) | [inline] |
Member access from a pointer.
Definition at line 421 of file PottsMesh.hpp.
References PottsMesh< DIM >::PottsElementIterator::IsAtEnd(), and PottsMesh< DIM >::PottsElementIterator::mElementIter.
Member Data Documentation
std::vector<PottsElement<DIM> *>::iterator PottsMesh< DIM >::PottsElementIterator::mElementIter [private] |
The actual element iterator.
Definition at line 377 of file PottsMesh.hpp.
Referenced by PottsMesh< DIM >::PottsElementIterator::IsAtEnd(), PottsMesh< DIM >::PottsElementIterator::operator!=(), PottsMesh< DIM >::PottsElementIterator::operator*(), PottsMesh< DIM >::PottsElementIterator::operator++(), PottsMesh< DIM >::PottsElementIterator::operator->(), and PottsMesh< DIM >::PottsElementIterator::PottsElementIterator().
PottsMesh<DIM>& PottsMesh< DIM >::PottsElementIterator::mrMesh [private] |
The mesh we're iterating over.
Definition at line 374 of file PottsMesh.hpp.
Referenced by PottsMesh< DIM >::PottsElementIterator::IsAtEnd(), and PottsMesh< DIM >::PottsElementIterator::PottsElementIterator().
bool PottsMesh< DIM >::PottsElementIterator::mSkipDeletedElements [private] |
Whether to skip deleted elements.
Definition at line 380 of file PottsMesh.hpp.
Referenced by PottsMesh< DIM >::PottsElementIterator::IsAllowedElement().
The documentation for this class was generated from the following file:
- cell_based/src/mesh/PottsMesh.hpp
