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

#include <CesiumUtility/IntrusivePointer.h>

Public Types
using	element_type = T
	The type pointed to by this pointer.

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.

	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.

	~IntrusivePointer () noexcept
	Default destructor.

	operator T* () noexcept
	Implicitly converts this implicit pointer to a raw pointer.

	operator const T * () const noexcept
	Implicitly converts this implicit pointer to a raw pointer.

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.

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
	Assigns an IntrusivePointer of another type to this IntrusivePointer.

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`.

	operator bool () 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
	Returns `true` if two pointers are equal.

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

template<class U>
bool	operator!= (const IntrusivePointer< U > &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<typename 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 21 of file IntrusivePointer.h.

Member Typedef Documentation

◆ element_type

template<typename T>

using CesiumUtility::IntrusivePointer< T >::element_type = T

The type pointed to by this pointer.

Definition at line 26 of file IntrusivePointer.h.

Constructor & Destructor Documentation

◆ IntrusivePointer() [1/5]

template<typename T>

CesiumUtility::IntrusivePointer< T >::IntrusivePointer ( T * p = nullptr )

inlinenoexcept

Default constructor.

Definition at line 31 of file IntrusivePointer.h.

◆ IntrusivePointer() [2/5]

template<typename T>

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

inlinenoexcept

Copy constructor.

Definition at line 36 of file IntrusivePointer.h.

◆ IntrusivePointer() [3/5]

template<typename T>

template<class U>

CesiumUtility::IntrusivePointer< T >::IntrusivePointer ( const IntrusivePointer & 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 48 of file IntrusivePointer.h.

◆ IntrusivePointer() [4/5]

template<typename T>

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

inlinenoexcept

Move constructor.

Definition at line 55 of file IntrusivePointer.h.

◆ IntrusivePointer() [5/5]

template<typename T>

template<class U>

CesiumUtility::IntrusivePointer< T >::IntrusivePointer ( IntrusivePointer && 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 68 of file IntrusivePointer.h.

◆ ~IntrusivePointer()

template<typename T>

CesiumUtility::IntrusivePointer< T >::~IntrusivePointer ( )

inlinenoexcept

Default destructor.

Definition at line 76 of file IntrusivePointer.h.

Member Function Documentation

◆ emplace()

template<typename 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 98 of file IntrusivePointer.h.

◆ get()

template<typename T>

T * CesiumUtility::IntrusivePointer< T >::get ( ) const

inlinenoexcept

Returns the internal pointer.

Definition at line 202 of file IntrusivePointer.h.

◆ operator bool() [1/2]

template<typename T>

CesiumUtility::IntrusivePointer< T >::operator bool ( ) const

inlineexplicitnoexcept

Implicit conversion to bool, being true iff this is not the nullptr.

Definition at line 191 of file IntrusivePointer.h.

◆ operator bool() [2/2]

template<typename T>

CesiumUtility::IntrusivePointer< T >::operator bool ( )

inlineexplicitnoexcept

Implicit conversion to bool, being true iff this is not the nullptr.

Definition at line 197 of file IntrusivePointer.h.

◆ operator const T *()

template<typename T>

CesiumUtility::IntrusivePointer< T >::operator const T * ( ) const

inlinenoexcept

Implicitly converts this implicit pointer to a raw pointer.

Definition at line 86 of file IntrusivePointer.h.

◆ operator T*()

template<typename T>

CesiumUtility::IntrusivePointer< T >::operator T* ( )

inlinenoexcept

Implicitly converts this implicit pointer to a raw pointer.

Definition at line 81 of file IntrusivePointer.h.

◆ operator!=() [1/3]

template<typename T>

bool CesiumUtility::IntrusivePointer< T >::operator!= ( const IntrusivePointer< T > & rhs ) const

inlinenoexcept

Returns true if two pointers are not equal.

Definition at line 220 of file IntrusivePointer.h.

◆ operator!=() [2/3]

template<typename T>

template<class U>

bool CesiumUtility::IntrusivePointer< T >::operator!= ( const IntrusivePointer & rhs ) const

inlinenoexcept

Returns true if two pointers are not equal.

Definition at line 228 of file IntrusivePointer.h.

◆ operator!=() [3/3]

template<typename T>

bool CesiumUtility::IntrusivePointer< T >::operator!= ( const T * pRhs ) const

inlinenoexcept

Returns true if the contents of this pointer is not equal to the given pointer.

Definition at line 242 of file IntrusivePointer.h.

◆ operator*()

template<typename T>

T & CesiumUtility::IntrusivePointer< T >::operator* ( ) const

inlinenoexcept

Dereferencing operator.

Definition at line 180 of file IntrusivePointer.h.

◆ operator->()

template<typename T>

T * CesiumUtility::IntrusivePointer< T >::operator-> ( ) const

inlinenoexcept

Arrow operator.

Definition at line 185 of file IntrusivePointer.h.

◆ operator=() [1/4]

template<typename T>

IntrusivePointer & CesiumUtility::IntrusivePointer< T >::operator= ( const IntrusivePointer< T > & rhs )

inlinenoexcept

Assignment operator.

Definition at line 113 of file IntrusivePointer.h.

◆ operator=() [2/4]

template<typename T>

template<class U>

IntrusivePointer & CesiumUtility::IntrusivePointer< T >::operator= ( const IntrusivePointer & rhs )

inlinenoexcept

Assigns an IntrusivePointer of another type to this IntrusivePointer.

Definition at line 133 of file IntrusivePointer.h.

◆ operator=() [3/4]

template<typename T>

IntrusivePointer & CesiumUtility::IntrusivePointer< T >::operator= ( IntrusivePointer< T > && rhs )

inlinenoexcept

Move assignment operator.

Definition at line 151 of file IntrusivePointer.h.

◆ operator=() [4/4]

template<typename T>

IntrusivePointer & CesiumUtility::IntrusivePointer< T >::operator= ( T * p )

inlinenoexcept

Assignment operator.

Definition at line 162 of file IntrusivePointer.h.

◆ operator==() [1/3]

template<typename T>

bool CesiumUtility::IntrusivePointer< T >::operator== ( const IntrusivePointer< T > & rhs ) const

inlinenoexcept

Returns true if two pointers are equal.

Definition at line 207 of file IntrusivePointer.h.

◆ operator==() [2/3]

template<typename T>

template<class U>

bool CesiumUtility::IntrusivePointer< T >::operator== ( const IntrusivePointer & rhs ) const

inlinenoexcept

Returns true if two pointers are equal.

Definition at line 213 of file IntrusivePointer.h.

◆ operator==() [3/3]

template<typename T>

bool CesiumUtility::IntrusivePointer< T >::operator== ( const T * pRhs ) const

inlinenoexcept

Returns true if the contents of this pointer is equal to the given pointer.

Definition at line 236 of file IntrusivePointer.h.

◆ reset()

template<typename T>

void CesiumUtility::IntrusivePointer< T >::reset ( )

inline

Reset this pointer to nullptr.

Definition at line 107 of file IntrusivePointer.h.

Friends And Related Symbol Documentation

◆ IntrusivePointer

template<typename T>

template<typename U>

friend class IntrusivePointer

friend

Definition at line 258 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 Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ element_type

Constructor & Destructor Documentation

◆ IntrusivePointer() [1/5]

◆ IntrusivePointer() [2/5]

◆ IntrusivePointer() [3/5]

◆ IntrusivePointer() [4/5]

◆ IntrusivePointer() [5/5]

◆ ~IntrusivePointer()

Member Function Documentation

◆ emplace()

◆ get()

◆ operator bool() [1/2]

◆ operator bool() [2/2]

◆ operator const T *()

◆ operator T*()

◆ operator!=() [1/3]

◆ operator!=() [2/3]

◆ operator!=() [3/3]

◆ operator*()

◆ operator->()

◆ operator=() [1/4]

◆ operator=() [2/4]

◆ operator=() [3/4]

◆ operator=() [4/4]

◆ operator==() [1/3]

◆ operator==() [2/3]

◆ operator==() [3/3]

◆ reset()

Friends And Related Symbol Documentation

◆ IntrusivePointer