FaceIterator< M, _Face, _CellHandle > Class Template Reference

An iterator of faces in a simplicial mesh. More...

#include <FaceIterator.h>

List of all members.

Public Types

typedef Base::iterator_category iterator_category
 Iterator category.
typedef Base::value_type value_type
 Value type.
typedef Base::difference_type difference_type
 Pointer difference type.
typedef Base::pointer pointer
 Pointer to the value type.
typedef Base::reference reference
 Reference to the value type.
typedef _Face Face
 A face in the mesh.
typedef _CellHandle CellHandle
 A handle to a cell.

Public Member Functions

Constructors for the mesh to call.

 FaceIterator (const CellHandle c, const CellHandle cellsEnd)
 Construct a face const iterator for the mesh.
Constructors etc.

 FaceIterator (const FaceIterator &other)
 Copy constructor.
FaceIteratoroperator= (const FaceIterator &other)
 Assignment operator.
 ~FaceIterator ()
 Destructor.
const FacegetFace () const
 The face.
const CellHandlegetCellsEnd () const
 The end of the list of cells.
template<typename AnyFace , typename AnyCellHandle >
 FaceIterator (const FaceIterator< M, AnyFace, AnyCellHandle > &other)
 Conversion from iterator to const iterator.
Forward iterator requirements

reference operator* () const
 Dereference.
pointer operator-> () const
 Return a const pointer to the face.
FaceIteratoroperator++ ()
 Pre-increment.
FaceIterator operator++ (int)
 Post-increment.
Bidirectional iterator requirements

FaceIteratoroperator-- ()
 Pre-decrement.
FaceIterator operator-- (int)
 Post-decrement.
Equality.

bool operator== (const FaceIterator &x)
 Return true if x is an iterator to the same face.
bool operator!= (const FaceIterator &x)
 Return true if x is not an iterator to the same face.

Detailed Description

template<int M, typename _Face, typename _CellHandle>
class FaceIterator< M, _Face, _CellHandle >

An iterator of faces in a simplicial mesh.


Member Function Documentation

template<int M, typename _Face, typename _CellHandle>
const CellHandle& FaceIterator< M, _Face, _CellHandle >::getCellsEnd (  )  const [inline]

The end of the list of cells.

This is needed for the conversion constructor.

template<int M, typename _Face, typename _CellHandle>
const Face& FaceIterator< M, _Face, _CellHandle >::getFace (  )  const [inline]

The face.

This is needed for the conversion constructor.

template<int M, typename _Face, typename _CellHandle>
FaceIterator FaceIterator< M, _Face, _CellHandle >::operator++ ( int   )  [inline]

Post-increment.

Note:
This is not efficient. If possible, use the pre-increment operator instead.
template<int M, typename _Face, typename _CellHandle>
FaceIterator FaceIterator< M, _Face, _CellHandle >::operator-- ( int   )  [inline]

Post-decrement.

Note:
This is not efficient. If possible, use the pre-decrement operator instead.

The documentation for this class was generated from the following file:
Generated on Thu Jun 30 02:14:58 2016 for Computational Geometry Package by  doxygen 1.6.3