Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::IUserDataList Class Referenceabstract

Interface of a list that manages user data. More...

#include <arcane/utils/IUserDataList.h>

Inheritance diagram for Arcane::IUserDataList:
Collaboration diagram for Arcane::IUserDataList:

Public Member Functions

virtual ~IUserDataList ()
 Frees resources.
virtual void setData (const String &name, IUserData *ud)=0
 Sets the user data associated with the name name.
virtual IUserDatadata (const String &name, bool allow_null=false) const =0
 Data associated with name.
virtual void removeData (const String &name, bool allow_null=false)=0
 Removes the data associated with the name name.
virtual void clear ()=0
 Removes all user data.

Detailed Description

Interface of a list that manages user data.

Definition at line 37 of file IUserDataList.h.

Constructor & Destructor Documentation

◆ ~IUserDataList()

virtual Arcane::IUserDataList::~IUserDataList ( )
inlinevirtual

Frees resources.

Definition at line 42 of file IUserDataList.h.

Member Function Documentation

◆ clear()

virtual void Arcane::IUserDataList::clear ( )
pure virtual

Removes all user data.

This is equivalent to calling removeData() for all user data.

Implemented in Arcane::UserDataList.

◆ data()

virtual IUserData * Arcane::IUserDataList::data ( const String & name,
bool allow_null = false ) const
pure virtual

Data associated with name.

An exception is thrown if allow_null is false and no data is associated with name. If allow_null is true and no data is associated, a null pointer is returned.

Implemented in Arcane::UserDataList.

Referenced by Arcane::ICartesianMesh::getReference().

Here is the caller graph for this function:

◆ removeData()

virtual void Arcane::IUserDataList::removeData ( const String & name,
bool allow_null = false )
pure virtual

Removes the data associated with the name name.

An exception is thrown if allow_null is false and no data is associated with name.

Implemented in Arcane::UserDataList.

◆ setData()

virtual void Arcane::IUserDataList::setData ( const String & name,
IUserData * ud )
pure virtual

Sets the user data associated with the name name.

No data should already be associated with name, otherwise an exception is thrown.

Implemented in Arcane::UserDataList.

Referenced by Arcane::ICartesianMesh::getReference().

Here is the caller graph for this function:

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