WeakPointerTo is similar to PointerTo, except that it does not actually prevent the referenced pointer from deleting. More...
#include "weakPointerTo.h"
Inheritance diagram for WeakPointerTo< T >:
Public Types | |
| typedef WeakPointerToBase< T >::To | To |
 Public Types inherited from WeakPointerToBase< T > | |
| typedef T | To |
Public Member Functions | |
| WeakPointerTo (To *ptr) | |
| WeakPointerTo (const PointerTo< T > ©) | |
| WeakPointerTo (const WeakPointerTo< T > ©) | |
| WeakPointerTo (WeakPointerTo< T > &&from) noexcept | |
| template<class Y > | |
| WeakPointerTo (const WeakPointerTo< Y > &r) noexcept | |
| template<class Y > | |
| WeakPointerTo (const PointerTo< Y > &r) noexcept | |
| template<class Y > | |
| WeakPointerTo (WeakPointerTo< Y > &&r) noexcept | |
| void | clear () |
| To * | get_orig () const |
| Returns the original pointer value, even if the object has since been deleted. More... | |
| PointerTo< T > | lock () const |
| A thread-safe way to access the underlying pointer; will silently return null if the underlying pointer was deleted or null. More... | |
| To & | operator * () const |
| To * | operator -> () const |
| operator T * () const | |
| We also have the typecast operator to automatically convert WeakPointerTo's to the required kind of actual pointer. More... | |
| WeakPointerTo< T > & | operator= (To *ptr) |
| WeakPointerTo< T > & | operator= (const PointerTo< T > ©) |
| WeakPointerTo< T > & | operator= (const WeakPointerTo< T > ©) |
| WeakPointerTo< T > & | operator= (WeakPointerTo< T > &&from) noexcept |
| template<class Y > | |
| WeakPointerTo< T > & | operator= (const WeakPointerTo< Y > &r) noexcept |
| template<class Y > | |
| WeakPointerTo< T > & | operator= (const PointerTo< Y > &r) noexcept |
| template<class Y > | |
| WeakPointerTo< T > & | operator= (WeakPointerTo< Y > &&r) noexcept |
| To * | p () const |
| Returns an ordinary pointer instead of a WeakPointerTo. More... | |
| Public Member Functions inherited from WeakPointerToBase< T > | |
| void | clear () |
| A convenient way to set the PointerTo object to NULL. More... | |
| bool | operator != (const To *other) const |
| bool | operator != (To *other) const |
| bool | operator != (std::nullptr_t) const |
| bool | operator != (const WeakPointerToBase< To > &other) const |
| bool | operator != (const PointerToBase< To > &other) const |
| Returns false if both pointers point to the same object. More... | |
| bool | operator > (const To *other) const |
| bool | operator > (To *other) const |
| bool | operator > (std::nullptr_t) const |
| bool | operator > (const WeakPointerToBase< To > &other) const |
| Defines an ordering between WeakPointerTo based on their raw pointer value. More... | |
| bool | operator > (const PointerToBase< To > &other) const |
| bool | operator >= (const To *other) const |
| bool | operator >= (To *other) const |
| bool | operator >= (std::nullptr_t) const |
| bool | operator >= (const WeakPointerToBase< To > &other) const |
| Defines an ordering between WeakPointerTo based on their raw pointer value. More... | |
| bool | operator >= (const PointerToBase< To > &other) const |
| bool | operator< (const To *other) const |
| bool | operator< (std::nullptr_t) const |
| bool | operator< (const WeakPointerToBase< To > &other) const |
| Defines an ordering between WeakPointerTo based on their raw pointer value. More... | |
| bool | operator< (const PointerToBase< To > &other) const |
| bool | operator<= (const To *other) const |
| bool | operator<= (To *other) const |
| bool | operator<= (std::nullptr_t) const |
| bool | operator<= (const WeakPointerToBase< To > &other) const |
| Defines an ordering between WeakPointerTo based on their raw pointer value. More... | |
| bool | operator<= (const PointerToBase< To > &other) const |
| bool | operator== (const To *other) const |
| bool | operator== (To *other) const |
| bool | operator== (std::nullptr_t) const |
| bool | operator== (const WeakPointerToBase< To > &other) const |
| Returns true if both pointers have the same raw pointer value. More... | |
| bool | operator== (const PointerToBase< To > &other) const |
| Returns true if both pointers point to the same object. More... | |
| void | output (std::ostream &out) const |
| A handy function to output PointerTo's as a hex pointer followed by a reference count. More... | |
| template<class Y > | |
| bool | owner_before (const WeakPointerToBase< Y > &other) const noexcept |
| Defines an ordering that is guaranteed to remain consistent even after the weak pointers have expired. More... | |
| template<class Y > | |
| bool | owner_before (const PointerToBase< Y > &other) const noexcept |
| Defines an ordering that is guaranteed to remain consistent even after this weak pointer has expired. More... | |
| void | refresh () const |
| Informs the WeakPointerTo object that its pointer is no longer deleted. More... | |
| Public Member Functions inherited from WeakPointerToVoid | |
| void | add_callback (WeakPointerCallback *callback) const |
| Sets a callback that will be made when the pointer is deleted. More... | |
| bool | is_valid_pointer () const |
| Returns true if the pointer is not null and the object has not been deleted. More... | |
| void | remove_callback (WeakPointerCallback *callback) const |
| Removes a previously added callback. More... | |
| bool | was_deleted () const |
| Returns true if the object we are pointing to has been deleted, false otherwise. More... | |
| Public Member Functions inherited from PointerToVoid | |
| size_t | get_hash () const |
| constexpr bool | is_null () const |
| Returns true if the PointerTo is a NULL pointer, false otherwise. More... | |
| bool | operator != (const PointerToVoid &other) const |
| bool | operator< (const void *other) const |
| bool | operator< (const PointerToVoid &other) const |
| bool | operator== (const PointerToVoid &other) const |
| void | swap (PointerToVoid &other) noexcept |
| Swaps the contents of this PointerTo with the other, without touching the reference counts. More... | |
Detailed Description
template<class T>
class WeakPointerTo< T >
WeakPointerTo is similar to PointerTo, except that it does not actually prevent the referenced pointer from deleting.
Instead, the referenced pointer is allowed to delete, but if this happens then was_deleted() will return true, and it will be an assertion error to dereference the pointer thereafter.
Definition at line 29 of file weakPointerTo.h.
Member Function Documentation
◆ get_orig()
template<class T >
|
inline |
Returns the original pointer value, even if the object has since been deleted.
Definition at line 152 of file weakPointerTo.I.
◆ lock()
template<class T >
|
inline |
A thread-safe way to access the underlying pointer; will silently return null if the underlying pointer was deleted or null.
Note that this may return null even if was_deleted() still returns true, which can occur if the object has reached reference count 0 and is about to be destroyed.
- Since
- 1.10.0
Definition at line 129 of file weakPointerTo.I.
◆ operator T *()
template<class T >
|
inlineexplicit |
We also have the typecast operator to automatically convert WeakPointerTo's to the required kind of actual pointer.
This introduces ambiguities which the compiler will resolve one way or the other, but we don't care which way it goes because either will be correct.
Definition at line 113 of file weakPointerTo.I.
◆ p()
template<class T >
|
inline |
Returns an ordinary pointer instead of a WeakPointerTo.
Useful to work around compiler problems, particularly for implicit upcasts.
Definition at line 141 of file weakPointerTo.I.
The documentation for this class was generated from the following files:
- panda/src/express/weakPointerTo.h
- panda/src/express/weakPointerTo.I
