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

Base class for a collection. More...

#include <arccore/common/Collection.h>

Public Member Functions

 CollectionBase (const CollectionBase &rhs)
 CollectionBase ()=default
 Creates a null collection.
CollectionBase & operator= (const CollectionBase &rhs)
void clear ()
 Removes all elements from the collection.
Integer count () const
 Number of elements in the collection.
bool empty () const
 True if the collection is empty.
CollectionChangeEventHandler & change ()
 Event invoked when the collection changes.

Protected Member Functions

 CollectionBase (Impl *vb)
Impl * _ref ()
const Impl * _ref () const
Impl * _noNullRef ()
const Impl * _noNullRef () const
void _setRef (Impl *new_impl)

Detailed Description

Base class for a collection.

Definition at line 475 of file arccore/src/common/arccore/common/Collection.h.

Constructor & Destructor Documentation

◆ CollectionBase() [1/3]

Arcane::CollectionBase::CollectionBase ( const CollectionBase & rhs)
inline

◆ ~CollectionBase()

Arcane::CollectionBase::~CollectionBase ( )
inline

◆ CollectionBase() [2/3]

Arcane::CollectionBase::CollectionBase ( )
default

Creates a null collection.

The instance is not usable until it has been assigned to a non-null collection (e.g., a vector).

◆ CollectionBase() [3/3]

Arcane::CollectionBase::CollectionBase ( Impl * vb)
inlineexplicitprotected

Member Function Documentation

◆ _noNullRef() [1/2]

Impl * Arcane::CollectionBase::_noNullRef ( )
inlineprotected

◆ _noNullRef() [2/2]

const Impl * Arcane::CollectionBase::_noNullRef ( ) const
inlineprotected

◆ _ref() [1/2]

Impl * Arcane::CollectionBase::_ref ( )
inlineprotected

◆ _ref() [2/2]

const Impl * Arcane::CollectionBase::_ref ( ) const
inlineprotected

◆ _setRef()

void Arcane::CollectionBase::_setRef ( Impl * new_impl)
inlineprotected

◆ change()

CollectionChangeEventHandler & Arcane::CollectionBase::change ( )
inline

Event invoked when the collection changes.

Definition at line 518 of file arccore/src/common/arccore/common/Collection.h.

◆ clear()

void Arcane::CollectionBase::clear ( )
inline

Removes all elements from the collection.

Definition at line 512 of file arccore/src/common/arccore/common/Collection.h.

Referenced by Arcane::StringDictionary::fill(), and Arcane::platform::fillCommandLineArguments().

◆ count()

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

Number of elements in the collection.

Definition at line 514 of file arccore/src/common/arccore/common/Collection.h.

Referenced by empty(), and Arcane::ArccoreApplicationBuildInfo::parseArgumentsAndSetDefaultsValues().

◆ empty()

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

True if the collection is empty.

Definition at line 516 of file arccore/src/common/arccore/common/Collection.h.

References count().

◆ operator=()

CollectionBase & Arcane::CollectionBase::operator= ( const CollectionBase & rhs)
inline

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