Arcane  4.1.12.0
User documentation
Loading...
Searching...
No Matches
Arcane::ItemEnumerator Class Reference

Enumerator over a list of entities. More...

#include <arcane/core/ItemEnumerator.h>

Public Types

typedef ItemInternal * ItemInternalPtr
using BaseClass = ItemEnumeratorBaseT<Item>

Public Member Functions

 ItemEnumerator (const ItemInternalVectorView &view)
 ItemEnumerator (const ItemInternalEnumerator &rhs)
 ItemEnumerator (const impl::ItemIndexedListView< DynExtent > &rhs)
template<int E>
 ItemEnumerator (const ItemConnectedListView< E > &rhs)
 ItemEnumerator (const ItemInternalPtr *items, const Int32 *local_ids, Integer n, const ItemGroupImpl *agroup=nullptr)
 ItemEnumerator (const ItemInternalArrayView &items, const Int32ConstArrayView &local_ids, const ItemGroupImpl *agroup=nullptr)
 ItemEnumerator (const ItemInternalVectorView &view, const ItemGroupImpl *agroup)
Public Member Functions inherited from Arcane::ItemEnumeratorBaseT< Item >
constexpr const ItemInternalPtr * unguardedItems () const
constexpr ItemInternal * internal () const
constexpr Item operator* () const
constexpr const Item * operator-> () const
constexpr LocalIdType asItemLocalId () const
constexpr operator LocalIdType () const
ItemEnumerator toItemEnumerator () const
impl::ItemBase _internalItemBase () const
Public Member Functions inherited from Arcane::ItemEnumeratorBase
constexpr void operator++ ()
 Increments the enumerator index.
constexpr bool operator() ()
constexpr bool hasNext ()
 True if the end of the enumerator has not been reached (index()<count()).
constexpr Integer count () const
 Number of elements in the enumerator.
constexpr Integer index () const
 Current index of the enumerator.
Int32 itemLocalId () const
 localId() of the current entity.
Int32 localId () const
 localId() of the current entity.
constexpr const Int32 * unguardedLocalIds () const
constexpr const ItemGroupImpl * group () const
 Underlying group if it exists (nullptr otherwise).

Static Public Member Functions

static ItemEnumerator fromItemEnumerator (const ItemEnumerator &rhs)
Static Public Member Functions inherited from Arcane::ItemEnumeratorBase
static constexpr int version ()

Protected Member Functions

 ItemEnumerator (ItemSharedInfo *s, const Int32ConstArrayView &local_ids)
 ItemEnumerator (ItemSharedInfo *s, const impl::ItemLocalIdListContainerView &view)
Protected Member Functions inherited from Arcane::ItemEnumeratorBaseT< Item >
 ItemEnumeratorBaseT (ItemSharedInfo *shared_info, const Int32ConstArrayView &local_ids)
 ItemEnumeratorBaseT (const ItemInfoListView &items, const Int32ConstArrayView &local_ids, const ItemGroupImpl *agroup)
 ItemEnumeratorBaseT (const ItemInternalVectorView &view, const ItemGroupImpl *agroup)
 ItemEnumeratorBaseT (const ItemVectorView &rhs)
 ItemEnumeratorBaseT (const ItemVectorViewT< Item > &rhs)
 ItemEnumeratorBaseT (const ItemEnumerator &rhs)
 ItemEnumeratorBaseT (const impl::ItemIndexedListView< DynExtent > &view)
 ItemEnumeratorBaseT (const ItemConnectedListViewT< Item > &rhs)
 ItemEnumeratorBaseT (ItemSharedInfo *si, const impl::ItemLocalIdListContainerView &view)
 ItemEnumeratorBaseT (const ItemInternalPtr *items, const Int32 *local_ids, Integer n, const ItemGroupImpl *agroup)
 ItemEnumeratorBaseT (const ItemInternalArrayView &items, const Int32ConstArrayView &local_ids, const ItemGroupImpl *agroup)
 ItemEnumeratorBaseT (const ItemInternalEnumerator &rhs)
 ItemEnumeratorBaseT (const ItemEnumerator &rhs, bool)
 Constructor only used by fromItemEnumerator().
 ItemEnumeratorBaseT (const impl::ItemLocalIdListContainerView &view, Int32 index, const ItemGroupImpl *agroup, Item item_base)
void _init (const ItemInternalPtr *items)
Protected Member Functions inherited from Arcane::ItemEnumeratorBase
 ItemEnumeratorBase (const ItemInternalPtr *, const Int32 *local_ids, Integer n, const ItemGroupImpl *agroup)
 ItemEnumeratorBase (const Int32ConstArrayView &local_ids)
 ItemEnumeratorBase (const Int32ConstArrayView &local_ids, const ItemGroupImpl *agroup)
 ItemEnumeratorBase (const ItemInternalVectorView &view, const ItemGroupImpl *agroup)
 ItemEnumeratorBase (const ItemVectorView &rhs)
template<int E>
 ItemEnumeratorBase (const ItemConnectedListView< E > &rhs)
 ItemEnumeratorBase (const ItemEnumerator &rhs)
 ItemEnumeratorBase (const ItemEnumerator &rhs, bool)
 Constructor only used by fromItemEnumerator().
 ItemEnumeratorBase (const impl::ItemLocalIdListContainerView &view, Int32 index, const ItemGroupImpl *agroup)
 ItemEnumeratorBase (const impl::ItemLocalIdListContainerView &view)
ItemInternal * _internal (ItemSharedInfo *si) const
constexpr const ItemInternalPtr * _unguardedItems (ItemSharedInfo *si) const

Friends

class ItemEnumeratorCS
class ItemGroup
class ItemVector
class ItemVectorView
class ItemPairEnumerator
template<int Extent>
class ItemConnectedListView
class ItemEnumeratorBaseT< Item >
class ItemEnumeratorBaseT< Node >
class ItemEnumeratorBaseT< ItemWithNodes >
class ItemEnumeratorBaseT< Edge >
class ItemEnumeratorBaseT< Face >
class ItemEnumeratorBaseT< Cell >
class ItemEnumeratorBaseT< Particle >
class ItemEnumeratorBaseT< DoF >
void _arcaneInternalItemEnumeratorSwigSet (const ItemEnumerator *ie, ItemEnumeratorPOD *vpod)

Additional Inherited Members

Protected Attributes inherited from Arcane::ItemEnumeratorBaseT< Item >
Item m_item
Protected Attributes inherited from Arcane::ItemEnumeratorBase
impl::ItemLocalIdListContainerView m_view
Int32 m_index = 0
const ItemGroupImpl * m_group_impl = nullptr

Detailed Description

Enumerator over a list of entities.

Definition at line 58 of file ItemEnumerator.h.

Member Typedef Documentation

◆ BaseClass

using Arcane::ItemEnumerator::BaseClass = ItemEnumeratorBaseT<Item>

Definition at line 85 of file ItemEnumerator.h.

◆ ItemInternalPtr

typedef ItemInternal* Arcane::ItemEnumerator::ItemInternalPtr

Definition at line 84 of file ItemEnumerator.h.

Constructor & Destructor Documentation

◆ ItemEnumerator() [1/9]

Arcane::ItemEnumerator::ItemEnumerator ( const ItemInternalVectorView & view)
inline

Definition at line 91 of file ItemEnumerator.h.

◆ ItemEnumerator() [2/9]

Arcane::ItemEnumerator::ItemEnumerator ( const ItemInternalEnumerator & rhs)
inline

Definition at line 95 of file ItemEnumerator.h.

◆ ItemEnumerator() [3/9]

Arcane::ItemEnumerator::ItemEnumerator ( const impl::ItemIndexedListView< DynExtent > & rhs)
inline

Definition at line 99 of file ItemEnumerator.h.

◆ ItemEnumerator() [4/9]

template<int E>
Arcane::ItemEnumerator::ItemEnumerator ( const ItemConnectedListView< E > & rhs)
inline

Definition at line 106 of file ItemEnumerator.h.

◆ ItemEnumerator() [5/9]

Arcane::ItemEnumerator::ItemEnumerator ( const ItemInternalPtr * items,
const Int32 * local_ids,
Integer n,
const ItemGroupImpl * agroup = nullptr )
inline

Definition at line 120 of file ItemEnumerator.h.

◆ ItemEnumerator() [6/9]

Arcane::ItemEnumerator::ItemEnumerator ( const ItemInternalArrayView & items,
const Int32ConstArrayView & local_ids,
const ItemGroupImpl * agroup = nullptr )
inline

Definition at line 125 of file ItemEnumerator.h.

◆ ItemEnumerator() [7/9]

Arcane::ItemEnumerator::ItemEnumerator ( const ItemInternalVectorView & view,
const ItemGroupImpl * agroup )
inline

Definition at line 130 of file ItemEnumerator.h.

◆ ItemEnumerator() [8/9]

Arcane::ItemEnumerator::ItemEnumerator ( ItemSharedInfo * s,
const Int32ConstArrayView & local_ids )
inlineprotected

Definition at line 137 of file ItemEnumerator.h.

◆ ItemEnumerator() [9/9]

Arcane::ItemEnumerator::ItemEnumerator ( ItemSharedInfo * s,
const impl::ItemLocalIdListContainerView & view )
inlineprotected

Definition at line 141 of file ItemEnumerator.h.

Member Function Documentation

◆ fromItemEnumerator()

ItemEnumerator Arcane::ItemEnumerator::fromItemEnumerator ( const ItemEnumerator & rhs)
inlinestatic

Definition at line 147 of file ItemEnumerator.h.

◆ _arcaneInternalItemEnumeratorSwigSet

void _arcaneInternalItemEnumeratorSwigSet ( const ItemEnumerator * ie,
ItemEnumeratorPOD * vpod )
friend

Definition at line 54 of file ItemEnumerator.cc.

◆ ItemConnectedListView

template<int Extent>
friend class ItemConnectedListView
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< Cell >

friend class ItemEnumeratorBaseT< Cell >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< DoF >

friend class ItemEnumeratorBaseT< DoF >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< Edge >

friend class ItemEnumeratorBaseT< Edge >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< Face >

friend class ItemEnumeratorBaseT< Face >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< Item >

friend class ItemEnumeratorBaseT< Item >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< ItemWithNodes >

friend class ItemEnumeratorBaseT< ItemWithNodes >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< Node >

friend class ItemEnumeratorBaseT< Node >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorBaseT< Particle >

friend class ItemEnumeratorBaseT< Particle >
friend

Definition at line 66 of file ItemEnumerator.h.

◆ ItemEnumeratorCS

friend class ItemEnumeratorCS
friend

Definition at line 61 of file ItemEnumerator.h.

◆ ItemGroup

friend class ItemGroup
friend

Definition at line 62 of file ItemEnumerator.h.

◆ ItemPairEnumerator

friend class ItemPairEnumerator
friend

Definition at line 65 of file ItemEnumerator.h.

◆ ItemVector

friend class ItemVector
friend

Definition at line 63 of file ItemEnumerator.h.

◆ ItemVectorView

friend class ItemVectorView
friend

Definition at line 64 of file ItemEnumerator.h.

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