Arcane  4.1.12.0
Developer documentation
Loading...
Searching...
No Matches
Arcane::AutoDestroyUserData< T, DestroyBehaviour > Class Template Reference

UserData that self-destructs once detached. More...

#include <arcane/utils/AutoDestroyUserData.h>

Inheritance diagram for Arcane::AutoDestroyUserData< T, DestroyBehaviour >:
Collaboration diagram for Arcane::AutoDestroyUserData< T, DestroyBehaviour >:

Public Member Functions

 AutoDestroyUserData (T *adata)
virtual void notifyAttach ()
 Method executed when the instance is attached.
virtual void notifyDetach ()
 Method executed when the instance is detached.
T * data ()
Public Member Functions inherited from Arcane::IUserData
virtual ~IUserData ()
 Releases resources.

Private Attributes

T * m_data

Detailed Description

template<typename T, typename DestroyBehaviour = DeleteOnDestroyBehaviour<T>>
class Arcane::AutoDestroyUserData< T, DestroyBehaviour >

UserData that self-destructs once detached.

An instance of this class must be allocated via new() and is automatically destroyed along with its associated data when it is detached from an IUserDataList via IUserDataList::removeData().

By default, it calls the delete operator for its data but it is possible to change its behavior via the DestroyBehaviour template parameter.

Definition at line 52 of file AutoDestroyUserData.h.

Constructor & Destructor Documentation

◆ AutoDestroyUserData()

template<typename T, typename DestroyBehaviour = DeleteOnDestroyBehaviour<T>>
Arcane::AutoDestroyUserData< T, DestroyBehaviour >::AutoDestroyUserData ( T * adata)
inline

Definition at line 57 of file AutoDestroyUserData.h.

◆ ~AutoDestroyUserData()

template<typename T, typename DestroyBehaviour = DeleteOnDestroyBehaviour<T>>
Arcane::AutoDestroyUserData< T, DestroyBehaviour >::~AutoDestroyUserData ( )
inlineprivate

Definition at line 63 of file AutoDestroyUserData.h.

Member Function Documentation

◆ data()

template<typename T, typename DestroyBehaviour = DeleteOnDestroyBehaviour<T>>
T * Arcane::AutoDestroyUserData< T, DestroyBehaviour >::data ( )
inline

Definition at line 78 of file AutoDestroyUserData.h.

◆ notifyAttach()

template<typename T, typename DestroyBehaviour = DeleteOnDestroyBehaviour<T>>
virtual void Arcane::AutoDestroyUserData< T, DestroyBehaviour >::notifyAttach ( )
inlinevirtual

Method executed when the instance is attached.

Implements Arcane::IUserData.

Definition at line 69 of file AutoDestroyUserData.h.

◆ notifyDetach()

template<typename T, typename DestroyBehaviour = DeleteOnDestroyBehaviour<T>>
virtual void Arcane::AutoDestroyUserData< T, DestroyBehaviour >::notifyDetach ( )
inlinevirtual

Method executed when the instance is detached.

Implements Arcane::IUserData.

Definition at line 71 of file AutoDestroyUserData.h.

Member Data Documentation

◆ m_data

template<typename T, typename DestroyBehaviour = DeleteOnDestroyBehaviour<T>>
T* Arcane::AutoDestroyUserData< T, DestroyBehaviour >::m_data
private

Definition at line 82 of file AutoDestroyUserData.h.


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