Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::VariableCollection Class Reference

Variable collection. More...

#include <arcane/core/VariableCollection.h>

Collaboration diagram for Arcane::VariableCollection:

Classes

class  Impl

Public Types

typedef VariableCollectionEnumerator Enumerator

Public Member Functions

 VariableCollection (const Enumerator &rhs)
void add (IVariable *var)
void add (VariableRef &var)
IVariablefront ()
Integer count () const
template<class Function>
Function each (Function f)
 Applies the functor f to all elements in the collection.
void clear ()
bool empty () const
VariableCollection clone () const
VariableCollectionEnumerator enumerator () const
bool contains (IVariable *v) const
bool contains (VariableRef &v) const
void sortByName (bool is_ascendent)
 Sorts the list by ascending or descending variable names.

Private Types

typedef Array< IVariable * > BaseClass

Private Member Functions

const Array< IVariable * > & _values () const
Array< IVariable * > & _values ()

Private Attributes

AutoRefT< Implm_p

Friends

class VariableCollectionEnumerator

Detailed Description

Variable collection.

This type has a reference semantics (like the SharedArray class).

Definition at line 88 of file VariableCollection.h.

Member Typedef Documentation

◆ BaseClass

typedef Array<IVariable*> Arcane::VariableCollection::BaseClass
private

Definition at line 111 of file VariableCollection.h.

◆ Enumerator

typedef VariableCollectionEnumerator Arcane::VariableCollection::Enumerator

Definition at line 116 of file VariableCollection.h.

Constructor & Destructor Documentation

◆ VariableCollection() [1/2]

Arcane::VariableCollection::VariableCollection ( )

Definition at line 25 of file VariableCollection.cc.

◆ VariableCollection() [2/2]

Arcane::VariableCollection::VariableCollection ( const Enumerator & rhs)

Definition at line 34 of file VariableCollection.cc.

Member Function Documentation

◆ _values() [1/2]

Array< IVariable * > & Arcane::VariableCollection::_values ( )
inlineprivate

Definition at line 191 of file VariableCollection.h.

◆ _values() [2/2]

const Array< IVariable * > & Arcane::VariableCollection::_values ( ) const
inlineprivate

Definition at line 190 of file VariableCollection.h.

◆ add() [1/2]

void Arcane::VariableCollection::add ( IVariable * var)
inline

Definition at line 125 of file VariableCollection.h.

◆ add() [2/2]

void Arcane::VariableCollection::add ( VariableRef & var)
inline

Definition at line 130 of file VariableCollection.h.

◆ clear()

void Arcane::VariableCollection::clear ( )
inline

Definition at line 153 of file VariableCollection.h.

◆ clone()

VariableCollection Arcane::VariableCollection::clone ( ) const
inline

Definition at line 163 of file VariableCollection.h.

◆ contains() [1/2]

bool Arcane::VariableCollection::contains ( IVariable * v) const
inline

Definition at line 175 of file VariableCollection.h.

◆ contains() [2/2]

bool Arcane::VariableCollection::contains ( VariableRef & v) const
inline

Definition at line 180 of file VariableCollection.h.

◆ count()

Integer Arcane::VariableCollection::count ( ) const
inline

Definition at line 140 of file VariableCollection.h.

◆ each()

template<class Function>
Function Arcane::VariableCollection::each ( Function f)
inline

Applies the functor f to all elements in the collection.

Definition at line 147 of file VariableCollection.h.

Referenced by Arcane::mesh::DynamicMesh::updateGhostLayerFromParent().

Here is the caller graph for this function:

◆ empty()

bool Arcane::VariableCollection::empty ( ) const
inline

Definition at line 158 of file VariableCollection.h.

◆ enumerator()

VariableCollectionEnumerator Arcane::VariableCollection::enumerator ( ) const
inline

Definition at line 170 of file VariableCollection.h.

◆ front()

IVariable * Arcane::VariableCollection::front ( )
inline

Definition at line 135 of file VariableCollection.h.

◆ sortByName()

void Arcane::VariableCollection::sortByName ( bool is_ascendent)

Sorts the list by ascending or descending variable names.

Definition at line 44 of file VariableCollection.cc.

References Arcane::Array< T >::begin(), Arcane::Array< T >::end(), Arcane::IVariable::fullName(), Arcane::Array< T >::rbegin(), and Arcane::Array< T >::rend().

Here is the call graph for this function:

◆ VariableCollectionEnumerator

friend class VariableCollectionEnumerator
friend

Definition at line 115 of file VariableCollection.h.

Member Data Documentation

◆ m_p

AutoRefT<Impl> Arcane::VariableCollection::m_p
private

Definition at line 195 of file VariableCollection.h.


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