Developer Documentation
Public Types | Public Member Functions | Private Attributes | List of all members
OpenVolumeMesh::BaseIterator< OH > Class Template Reference
Inheritance diagram for OpenVolumeMesh::BaseIterator< OH >:
OpenVolumeMesh::BaseCirculator< IH, OH >

Public Types

typedef std::bidirectional_iterator_tag iterator_category
 
typedef int difference_type
 
typedef const OH value_type
 
typedef const OH * pointer
 
typedef const OH & reference
 

Public Member Functions

 BaseIterator (const TopologyKernel *_mesh, const OH &_ch)
 
 BaseIterator (const TopologyKernel *_mesh)
 
 BaseIterator (const BaseIterator &_c)=default
 
BaseIterator & operator= (const BaseIterator &_c)=default
 
bool operator== (const BaseIterator &_c) const
 
bool operator!= (const BaseIterator &_c) const
 
pointer operator-> () const
 
reference operator* () const
 
bool operator< (const BaseIterator &_c) const
 
 operator bool () const
 
void valid (bool _valid)
 
bool valid () const
 
bool is_valid () const
 
void cur_handle (const OH &_h)
 
reference cur_handle () const
 
const TopologyKernel * mesh () const
 

Private Attributes

bool valid_
 
OH cur_handle_
 
const TopologyKernel * mesh_
 

Detailed Description

template<class OH>
class OpenVolumeMesh::BaseIterator< OH >

Definition at line 13 of file BaseIterator.hh.

Member Typedef Documentation

◆ difference_type

template<class OH >
typedef int OpenVolumeMesh::BaseIterator< OH >::difference_type

Definition at line 18 of file BaseIterator.hh.

◆ iterator_category

template<class OH >
typedef std::bidirectional_iterator_tag OpenVolumeMesh::BaseIterator< OH >::iterator_category

Definition at line 17 of file BaseIterator.hh.

◆ pointer

template<class OH >
typedef const OH* OpenVolumeMesh::BaseIterator< OH >::pointer

Definition at line 20 of file BaseIterator.hh.

◆ reference

template<class OH >
typedef const OH& OpenVolumeMesh::BaseIterator< OH >::reference

Definition at line 21 of file BaseIterator.hh.

◆ value_type

template<class OH >
typedef const OH OpenVolumeMesh::BaseIterator< OH >::value_type

Definition at line 19 of file BaseIterator.hh.

Constructor & Destructor Documentation

◆ BaseIterator() [1/3]

template<class OH >
OpenVolumeMesh::BaseIterator< OH >::BaseIterator ( const TopologyKernel *  _mesh,
const OH &  _ch 
)
inline

Definition at line 24 of file BaseIterator.hh.

◆ BaseIterator() [2/3]

template<class OH >
OpenVolumeMesh::BaseIterator< OH >::BaseIterator ( const TopologyKernel *  _mesh)
inlineexplicit

Definition at line 27 of file BaseIterator.hh.

◆ BaseIterator() [3/3]

template<class OH >
OpenVolumeMesh::BaseIterator< OH >::BaseIterator ( )
inline

Definition at line 31 of file BaseIterator.hh.

Member Function Documentation

◆ cur_handle() [1/2]

template<class OH >
reference OpenVolumeMesh::BaseIterator< OH >::cur_handle ( ) const
inline

Definition at line 75 of file BaseIterator.hh.

◆ cur_handle() [2/2]

template<class OH >
void OpenVolumeMesh::BaseIterator< OH >::cur_handle ( const OH &  _h)
inline

Definition at line 72 of file BaseIterator.hh.

◆ is_valid()

template<class OH >
bool OpenVolumeMesh::BaseIterator< OH >::is_valid ( void  ) const
inline

Definition at line 69 of file BaseIterator.hh.

◆ mesh()

template<class OH >
const TopologyKernel * OpenVolumeMesh::BaseIterator< OH >::mesh ( ) const
inline

Definition at line 78 of file BaseIterator.hh.

◆ operator bool()

template<class OH >
OpenVolumeMesh::BaseIterator< OH >::operator bool ( ) const
inline

Definition at line 58 of file BaseIterator.hh.

◆ operator!=()

template<class OH >
bool OpenVolumeMesh::BaseIterator< OH >::operator!= ( const BaseIterator< OH > &  _c) const
inline

Definition at line 42 of file BaseIterator.hh.

◆ operator*()

template<class OH >
reference OpenVolumeMesh::BaseIterator< OH >::operator* ( ) const
inline

Definition at line 50 of file BaseIterator.hh.

◆ operator->()

template<class OH >
pointer OpenVolumeMesh::BaseIterator< OH >::operator-> ( ) const
inline

Definition at line 46 of file BaseIterator.hh.

◆ operator<()

template<class OH >
bool OpenVolumeMesh::BaseIterator< OH >::operator< ( const BaseIterator< OH > &  _c) const
inline

Definition at line 54 of file BaseIterator.hh.

◆ operator==()

template<class OH >
bool OpenVolumeMesh::BaseIterator< OH >::operator== ( const BaseIterator< OH > &  _c) const
inline

Definition at line 37 of file BaseIterator.hh.

◆ valid() [1/2]

template<class OH >
bool OpenVolumeMesh::BaseIterator< OH >::valid ( ) const
inline

Definition at line 66 of file BaseIterator.hh.

◆ valid() [2/2]

template<class OH >
void OpenVolumeMesh::BaseIterator< OH >::valid ( bool  _valid)
inline

Definition at line 62 of file BaseIterator.hh.

Member Data Documentation

◆ cur_handle_

template<class OH >
OH OpenVolumeMesh::BaseIterator< OH >::cur_handle_
private

Definition at line 85 of file BaseIterator.hh.

◆ mesh_

template<class OH >
const TopologyKernel* OpenVolumeMesh::BaseIterator< OH >::mesh_
private

Definition at line 86 of file BaseIterator.hh.

◆ valid_

template<class OH >
bool OpenVolumeMesh::BaseIterator< OH >::valid_
private

Definition at line 84 of file BaseIterator.hh.

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