Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::ItemConnectedEnumeratorBaseT< ItemType > Class Template Reference

Typed base class for enumerators over a list of connected entities. More...

#include <arcane/core/ItemConnectedEnumeratorBase.h>

Inheritance diagram for Arcane::ItemConnectedEnumeratorBaseT< ItemType >:
Collaboration diagram for Arcane::ItemConnectedEnumeratorBaseT< ItemType >:

Public Member Functions

constexpr ItemType operator* () const
constexpr const ItemType * operator-> () const
constexpr LocalIdType asItemLocalId () const
Public Member Functions inherited from Arcane::ItemConnectedEnumeratorBase
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

ItemType m_item = ItemType(NULL_ITEM_LOCAL_ID, nullptr)
Protected Attributes inherited from Arcane::ItemConnectedEnumeratorBase
const Int32 *ARCANE_RESTRICT m_local_ids = nullptr
Int32 m_index = 0
Int32 m_count = 0
Int32 m_local_id_offset = 0

Private Types

using LocalIdType = typename ItemType::LocalIdType
using BaseClass = ItemConnectedEnumeratorBase

Private Member Functions

 ItemConnectedEnumeratorBaseT (ItemSharedInfo *shared_info, const Int32ConstArrayView &local_ids)
 ItemConnectedEnumeratorBaseT (const impl::ItemIndexedListView< DynExtent > &view)
 ItemConnectedEnumeratorBaseT (const ItemConnectedListViewT< ItemType > &rhs)
 ItemConnectedEnumeratorBaseT (const Int32 *local_ids, Int32 index, Int32 n, Item item_base)

Friends

class ItemConnectedEnumerator
class ItemConnectedEnumeratorT< ItemType >

Detailed Description

template<typename ItemType>
class Arcane::ItemConnectedEnumeratorBaseT< ItemType >

Typed base class for enumerators over a list of connected entities.

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

Definition at line 111 of file ItemConnectedEnumeratorBase.h.

Member Typedef Documentation

◆ BaseClass

template<typename ItemType>
using Arcane::ItemConnectedEnumeratorBaseT< ItemType >::BaseClass = ItemConnectedEnumeratorBase
private

Definition at line 120 of file ItemConnectedEnumeratorBase.h.

◆ LocalIdType

template<typename ItemType>
using Arcane::ItemConnectedEnumeratorBaseT< ItemType >::LocalIdType = typename ItemType::LocalIdType
private

Definition at line 119 of file ItemConnectedEnumeratorBase.h.

Constructor & Destructor Documentation

◆ ItemConnectedEnumeratorBaseT() [1/5]

template<typename ItemType>
Arcane::ItemConnectedEnumeratorBaseT< ItemType >::ItemConnectedEnumeratorBaseT ( )
inlineprivate

Definition at line 124 of file ItemConnectedEnumeratorBase.h.

◆ ItemConnectedEnumeratorBaseT() [2/5]

template<typename ItemType>
Arcane::ItemConnectedEnumeratorBaseT< ItemType >::ItemConnectedEnumeratorBaseT ( ItemSharedInfo * shared_info,
const Int32ConstArrayView & local_ids )
inlineprivate

Definition at line 129 of file ItemConnectedEnumeratorBase.h.

◆ ItemConnectedEnumeratorBaseT() [3/5]

template<typename ItemType>
Arcane::ItemConnectedEnumeratorBaseT< ItemType >::ItemConnectedEnumeratorBaseT ( const impl::ItemIndexedListView< DynExtent > & view)
inlineprivate

Definition at line 134 of file ItemConnectedEnumeratorBase.h.

◆ ItemConnectedEnumeratorBaseT() [4/5]

template<typename ItemType>
Arcane::ItemConnectedEnumeratorBaseT< ItemType >::ItemConnectedEnumeratorBaseT ( const ItemConnectedListViewT< ItemType > & rhs)
inlineprivate

Definition at line 138 of file ItemConnectedEnumeratorBase.h.

◆ ItemConnectedEnumeratorBaseT() [5/5]

template<typename ItemType>
Arcane::ItemConnectedEnumeratorBaseT< ItemType >::ItemConnectedEnumeratorBaseT ( const Int32 * local_ids,
Int32 index,
Int32 n,
Item item_base )
inlineprivate

Definition at line 143 of file ItemConnectedEnumeratorBase.h.

Member Function Documentation

◆ asItemLocalId()

template<typename ItemType>
LocalIdType Arcane::ItemConnectedEnumeratorBaseT< ItemType >::asItemLocalId ( ) const
inlineconstexpr

Definition at line 162 of file ItemConnectedEnumeratorBase.h.

◆ operator*()

template<typename ItemType>
ItemType Arcane::ItemConnectedEnumeratorBaseT< ItemType >::operator* ( ) const
inlineconstexpr

Definition at line 151 of file ItemConnectedEnumeratorBase.h.

◆ operator->()

template<typename ItemType>
const ItemType * Arcane::ItemConnectedEnumeratorBaseT< ItemType >::operator-> ( ) const
inlineconstexpr

Definition at line 156 of file ItemConnectedEnumeratorBase.h.

◆ ItemConnectedEnumerator

template<typename ItemType>
friend class ItemConnectedEnumerator
friend

Definition at line 114 of file ItemConnectedEnumeratorBase.h.

◆ ItemConnectedEnumeratorT< ItemType >

template<typename ItemType>
friend class ItemConnectedEnumeratorT< ItemType >
friend

Definition at line 114 of file ItemConnectedEnumeratorBase.h.

Member Data Documentation

◆ m_item

template<typename ItemType>
ItemType Arcane::ItemConnectedEnumeratorBaseT< ItemType >::m_item = ItemType(NULL_ITEM_LOCAL_ID, nullptr)
mutableprotected

Definition at line 169 of file ItemConnectedEnumeratorBase.h.

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