Arcane::CollectionBase Class Reference

Base class for a collection. More...

#include </__w/arcaneframework.github.io/arcaneframework.github.io/framework/arccore/src/common/arccore/common/Collection.h>

Inheritance diagram for Arcane::CollectionBase:

Collaboration diagram for Arcane::CollectionBase:

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)

Private Types
typedef CollectionImplBase	Impl

Private Attributes
AutoRef2< Impl >	m_ref

Detailed Description

Base class for a collection.

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

Member Typedef Documentation

Impl

typedef CollectionImplBase Arcane::CollectionBase::Impl

private

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

Constructor & Destructor Documentation

CollectionBase() [1/3]

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

inline

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

~CollectionBase()

Arcane::CollectionBase::~CollectionBase ( )

inline

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

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

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

Member Function Documentation

_noNullRef() [1/2]

Impl * Arcane::CollectionBase::_noNullRef ( )

inlineprotected

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

_noNullRef() [2/2]

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

inlineprotected

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

_ref() [1/2]

Impl * Arcane::CollectionBase::_ref ( )

inlineprotected

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

_ref() [2/2]

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

inlineprotected

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

_setRef()

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

inlineprotected

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

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::SubDomain::dumpInternalInfos(), Arcane::StringDictionary::fill(), Arcane::platform::fillCommandLineArguments(), Arcane::ArcaneMain::parseArgs(), and Arcane::TimeLoopReader::readTimeLoops().

Here is the caller graph for this function:

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 Arcane::ArcaneBasicMeshSubdividerService::_refineOnce(), Arcane::ParameterListWithCaseOption::addParameters(), Arcane::DumpWEnsight7::beginWrite(), Arcane::TimeLoopMng::doExecNextEntryPoint(), empty(), Arcane::TimeLoopMng::nextEntryPoint(), Arcane::ArcaneMain::parseArgs(), Arcane::ArccoreApplicationBuildInfo::parseArgumentsAndSetDefaultsValues(), and Arcane::TimeLoopMng::setUsedTimeLoop().

Here is the caller graph for this function:

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().

Referenced by Arcane::TimeLoopMng::doExecNextEntryPoint().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

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

inline

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

Member Data Documentation

m_ref

AutoRef2<Impl> Arcane::CollectionBase::m_ref

private

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

---

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

• arccore/src/common/arccore/common/Collection.h