Arcane::ItemConnectedEnumeratorBase Class Reference

Base class for enumerators over a list of connected entities. More...

#include <arcane/core/ItemConnectedEnumeratorBase.h>

Public Member Functions
constexpr void	operator++ ()
	Increments the enumerator index.
constexpr bool	operator() () const
	True if the end of the enumerator has not been reached (index()<count()).
constexpr bool	hasNext () const
	True if the end of the enumerator has not been reached (index()<count()).
constexpr Int32	count () const
	Number of elements in the enumerator.
constexpr Int32	index () const
	Current index of the enumerator.
constexpr ItemLocalId	itemLocalId () const
	localId() of the current entity.
constexpr Int32	localId () const
	localId() of the current entity.

Protected Attributes
const Int32 *ARCANE_RESTRICT	m_local_ids = nullptr
Int32	m_index = 0
Int32	m_count = 0
Int32	m_local_id_offset = 0

Friends
template<typename T>
class	ItemConnectedEnumeratorBaseT

Detailed Description

Base class for enumerators over a list of connected entities.

Instances of this class are created either via ItemConnectedEnumerator, or via ItemConnectedEnumeratorT.

for( ItemConnectedEnumeratorBase iter(...); iter.hasNext(); ++iter )
  ;

Definition at line 40 of file ItemConnectedEnumeratorBase.h.

Member Function Documentation

count()

Int32 Arcane::ItemConnectedEnumeratorBase::count ( ) const

inlineconstexpr

Number of elements in the enumerator.

Definition at line 82 of file ItemConnectedEnumeratorBase.h.

hasNext()

bool Arcane::ItemConnectedEnumeratorBase::hasNext ( ) const

inlineconstexpr

True if the end of the enumerator has not been reached (index()<count()).

Definition at line 79 of file ItemConnectedEnumeratorBase.h.

index()

Int32 Arcane::ItemConnectedEnumeratorBase::index ( ) const

inlineconstexpr

Current index of the enumerator.

Definition at line 85 of file ItemConnectedEnumeratorBase.h.

itemLocalId()

ItemLocalId Arcane::ItemConnectedEnumeratorBase::itemLocalId ( ) const

inlineconstexpr

localId() of the current entity.

Definition at line 88 of file ItemConnectedEnumeratorBase.h.

localId()

Int32 Arcane::ItemConnectedEnumeratorBase::localId ( ) const

inlineconstexpr

localId() of the current entity.

Definition at line 91 of file ItemConnectedEnumeratorBase.h.

operator()()

bool Arcane::ItemConnectedEnumeratorBase::operator() ( ) const

inlineconstexpr

True if the end of the enumerator has not been reached (index()<count()).

Definition at line 73 of file ItemConnectedEnumeratorBase.h.

operator++()

void Arcane::ItemConnectedEnumeratorBase::operator++ ( )

inlineconstexpr

Increments the enumerator index.

Definition at line 67 of file ItemConnectedEnumeratorBase.h.

Friends And Related Symbol Documentation

ItemConnectedEnumeratorBaseT

template<typename T>

friend class ItemConnectedEnumeratorBaseT

friend

Definition at line 43 of file ItemConnectedEnumeratorBase.h.

Member Data Documentation

m_count

Int32 Arcane::ItemConnectedEnumeratorBase::m_count = 0

protected

Definition at line 97 of file ItemConnectedEnumeratorBase.h.

m_index

Int32 Arcane::ItemConnectedEnumeratorBase::m_index = 0

protected

Definition at line 96 of file ItemConnectedEnumeratorBase.h.

m_local_id_offset

Int32 Arcane::ItemConnectedEnumeratorBase::m_local_id_offset = 0

protected

Definition at line 98 of file ItemConnectedEnumeratorBase.h.

m_local_ids

const Int32* ARCANE_RESTRICT Arcane::ItemConnectedEnumeratorBase::m_local_ids = nullptr

protected

Definition at line 95 of file ItemConnectedEnumeratorBase.h.

---

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

• ItemConnectedEnumeratorBase.h