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

Public Types

typedef BaseIterator< OH > BaseIter
 
- Public Types inherited from OpenVolumeMesh::BaseIterator< OH >
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

 BaseCirculator (const TopologyKernel *_mesh, const IH &_ih, const OH &_oh, int _max_laps=1)
 
 BaseCirculator (const TopologyKernel *_mesh, const IH &_ih, int _max_laps=1)
 
 BaseCirculator (const BaseCirculator &_c)=default
 
bool operator== (const BaseCirculator &_c) const
 
bool operator!= (const BaseCirculator &_c) const
 
bool operator< (const BaseCirculator &_c) const
 
BaseCirculator & operator= (const BaseCirculator &_c)=default
 
const IH & ref_handle () const
 
void lap (int _lap)
 
int lap () const
 
void max_laps (int _max_laps)
 
int max_laps () const
 
- Public Member Functions inherited from OpenVolumeMesh::BaseIterator< OH >
 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
 

Protected Attributes

int lap_
 
int max_laps_
 
IH ref_handle_
 

Detailed Description

template<class IH, class OH>
class OpenVolumeMesh::BaseCirculator< IH, OH >

Definition at line 10 of file BaseCirculator.hh.

Member Typedef Documentation

◆ BaseIter

template<class IH , class OH >
typedef BaseIterator<OH> OpenVolumeMesh::BaseCirculator< IH, OH >::BaseIter

Definition at line 13 of file BaseCirculator.hh.

Constructor & Destructor Documentation

◆ BaseCirculator() [1/3]

template<class IH , class OH >
OpenVolumeMesh::BaseCirculator< IH, OH >::BaseCirculator ( const TopologyKernel *  _mesh,
const IH &  _ih,
const OH &  _oh,
int  _max_laps = 1 
)
inline

Definition at line 15 of file BaseCirculator.hh.

◆ BaseCirculator() [2/3]

template<class IH , class OH >
OpenVolumeMesh::BaseCirculator< IH, OH >::BaseCirculator ( const TopologyKernel *  _mesh,
const IH &  _ih,
int  _max_laps = 1 
)
inline

Definition at line 22 of file BaseCirculator.hh.

◆ BaseCirculator() [3/3]

template<class IH , class OH >
OpenVolumeMesh::BaseCirculator< IH, OH >::BaseCirculator ( )
inline

Definition at line 30 of file BaseCirculator.hh.

Member Function Documentation

◆ lap() [1/2]

template<class IH , class OH >
int OpenVolumeMesh::BaseCirculator< IH, OH >::lap ( ) const
inline

Definition at line 64 of file BaseCirculator.hh.

◆ lap() [2/2]

template<class IH , class OH >
void OpenVolumeMesh::BaseCirculator< IH, OH >::lap ( int  _lap)
inline

Definition at line 61 of file BaseCirculator.hh.

◆ max_laps() [1/2]

template<class IH , class OH >
int OpenVolumeMesh::BaseCirculator< IH, OH >::max_laps ( ) const
inline

Definition at line 71 of file BaseCirculator.hh.

◆ max_laps() [2/2]

template<class IH , class OH >
void OpenVolumeMesh::BaseCirculator< IH, OH >::max_laps ( int  _max_laps)
inline

Definition at line 68 of file BaseCirculator.hh.

◆ operator!=()

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

Definition at line 44 of file BaseCirculator.hh.

◆ operator<()

template<class IH , class OH >
bool OpenVolumeMesh::BaseCirculator< IH, OH >::operator< ( const BaseCirculator< IH, OH > &  _c) const
inline

Definition at line 48 of file BaseCirculator.hh.

◆ operator==()

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

Definition at line 39 of file BaseCirculator.hh.

◆ ref_handle()

template<class IH , class OH >
const IH & OpenVolumeMesh::BaseCirculator< IH, OH >::ref_handle ( ) const
inline

Definition at line 57 of file BaseCirculator.hh.

Member Data Documentation

◆ lap_

template<class IH , class OH >
int OpenVolumeMesh::BaseCirculator< IH, OH >::lap_
protected

Definition at line 76 of file BaseCirculator.hh.

◆ max_laps_

template<class IH , class OH >
int OpenVolumeMesh::BaseCirculator< IH, OH >::max_laps_
protected

Definition at line 77 of file BaseCirculator.hh.

◆ ref_handle_

template<class IH , class OH >
IH OpenVolumeMesh::BaseCirculator< IH, OH >::ref_handle_
protected

Definition at line 78 of file BaseCirculator.hh.

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