A smart pointer that calls addReference and releaseReference on the controlled object. More...

#include <CesiumUtility/IntrusivePointer.h>

Public Member Functions
	IntrusivePointer (T *p=nullptr) noexcept
	Default constructor.

	IntrusivePointer (const IntrusivePointer< T > &rhs) noexcept
	Copy constructor.

template<class U >
	IntrusivePointer (const IntrusivePointer< U > &rhs) noexcept
	Implicit conversion to a pointer to a base (or otherwise convertible) type. More...

	IntrusivePointer (IntrusivePointer< T > &&rhs) noexcept
	Move constructor.

template<class U >
	IntrusivePointer (IntrusivePointer< U > &&rhs) noexcept
	Implicit conversion of an r-value to a pointer to a base (or otherwise convertible) type. More...

	~IntrusivePointer () noexcept
	Default destructor.

template<typename... ConstructorArgumentTypes>
T &	emplace (ConstructorArgumentTypes &&... constructorArguments)
	Constructs a new instance and assigns it to this IntrusivePointer. If this IntrusivePointer already points to another instance, releaseReference is called on it. More...

void	reset ()
	Reset this pointer to nullptr.

IntrusivePointer &	operator= (const IntrusivePointer &rhs) noexcept
	Assignment operator.

template<class U >
IntrusivePointer &	operator= (const IntrusivePointer< U > &rhs) noexcept

IntrusivePointer &	operator= (IntrusivePointer &&rhs) noexcept
	Move assignment operator.

IntrusivePointer &	operator= (T *p) noexcept
	Assignment operator.

T &	operator* () const noexcept
	Dereferencing operator.

T *	operator-> () const noexcept
	Arrow operator.

	operator bool () const noexcept
	Implicit conversion to `bool`, being `true` iff this is not the `nullptr`.

T *	get () const noexcept
	Returns the internal pointer.

bool	operator== (const IntrusivePointer< T > &rhs) const noexcept
	Returns `true` if two pointers are equal.

template<class U >
bool	operator== (const IntrusivePointer< U > &rhs) const noexcept

bool	operator!= (const IntrusivePointer< T > &rhs) const noexcept
	Returns `true` if two pointers are not equal.

bool	operator== (const T *pRhs) const noexcept
	Returns `true` if the contents of this pointer is equal to the given pointer.

bool	operator!= (const T *pRhs) const noexcept
	Returns `true` if the contents of this pointer is not equal to the given pointer.

Detailed Description

template<class T>
class CesiumUtility::IntrusivePointer< T >

A smart pointer that calls addReference and releaseReference on the controlled object.

Please note that the thread-safety of this type is entirely dependent on the implementation of addReference and releaseReference. If these methods are not thread safe on a particular type - which is common for objects that are not meant to be used from multiple threads simultaneously - then using an IntrusivePointer from multiple threads is also unsafe.

Template Parameters

T	The type of object controlled.

Definition at line 19 of file IntrusivePointer.h.

Constructor & Destructor Documentation

◆ IntrusivePointer() [1/2]

template<class T >

template<class U >

CesiumUtility::IntrusivePointer< T >::IntrusivePointer ( const IntrusivePointer< U > & rhs )

inlinenoexcept

Implicit conversion to a pointer to a base (or otherwise convertible) type.

Template Parameters

U	The new type, usually a base class.

Parameters

rhs	The pointer.

Definition at line 41 of file IntrusivePointer.h.

◆ IntrusivePointer() [2/2]

template<class T >

template<class U >

CesiumUtility::IntrusivePointer< T >::IntrusivePointer ( IntrusivePointer< U > && rhs )

inlinenoexcept

Implicit conversion of an r-value to a pointer to a base (or otherwise convertible) type.

Template Parameters

U	The new type, usually a base class.

Parameters

rhs	The pointer.

Definition at line 61 of file IntrusivePointer.h.

Member Function Documentation

◆ emplace()

template<class T >

template<typename... ConstructorArgumentTypes>

T& CesiumUtility::IntrusivePointer< T >::emplace ( ConstructorArgumentTypes &&... constructorArguments )

inline

Constructs a new instance and assigns it to this IntrusivePointer. If this IntrusivePointer already points to another instance, releaseReference is called on it.

Parameters

constructorArguments The arguments to the constructor to create the new instance.

Returns: A reference to the newly-created instance.

Definition at line 81 of file IntrusivePointer.h.

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

/home/runner/work/cesium-native/cesium-native/CesiumUtility/include/CesiumUtility/IntrusivePointer.h

Public Member Functions

Detailed Description

template<class T> class CesiumUtility::IntrusivePointer< T >

Constructor & Destructor Documentation

◆ IntrusivePointer() [1/2]

◆ IntrusivePointer() [2/2]

Member Function Documentation

◆ emplace()

template<class T>
class CesiumUtility::IntrusivePointer< T >