Loading...
Searching...
No Matches
TfAnyWeakPtr Class Reference

Provides the ability to hold an arbitrary TfWeakPtr in a non-type-specific manner in order to observe whether it has expired or not. More...

#include <anyWeakPtr.h>

Public Types

typedef TfAnyWeakPtr This
 

Public Member Functions

template<class Ptr , class = typename std::enable_if<Tf_SupportsWeakPtr< typename Ptr::DataType>::value>::type>
 TfAnyWeakPtr (Ptr const &ptr)
 Construct an AnyWeakPtr watching ptr.
 
 TfAnyWeakPtr ()
 Construct an AnyWeakPtr not watching any ptr.
 
 TfAnyWeakPtr (TfNullPtrType)
 Construct and implicitly convert from TfNullPtr.
 
 TfAnyWeakPtr (std::nullptr_t)
 Construct and implicitly convert from std::nullptr_t.
 
 TfAnyWeakPtr (TfAnyWeakPtr const &other)
 
TfAnyWeakPtroperator= (TfAnyWeakPtr const &other)
 
TF_API bool IsInvalid () const
 Return true only if this expiry checker is watching a weak pointer which has expired.
 
TF_API void const * GetUniqueIdentifier () const
 Return the unique identifier of the WeakPtr this AnyWeakPtr contains.
 
TF_API TfWeakBase const * GetWeakBase () const
 Return the TfWeakBase object of the WeakPtr we are holding.
 
TF_API operator bool () const
 bool operator
 
TF_API bool operator! () const
 operator !
 
TF_API bool operator== (const TfAnyWeakPtr &rhs) const
 equality operator
 
bool operator!= (const TfAnyWeakPtr &rhs) const
 inequality operator
 
TF_API bool operator< (const TfAnyWeakPtr &rhs) const
 comparison operator
 
bool operator<= (const TfAnyWeakPtr &rhs) const
 less than or equal operator
 
bool operator> (const TfAnyWeakPtr &rhs) const
 greater than operator
 
bool operator>= (const TfAnyWeakPtr &rhs) const
 greater than or equal operator
 
TF_API const std::type_info & GetTypeInfo () const
 returns the type_info of the underlying WeakPtr
 
TF_API TfType const & GetType () const
 Returns the TfType of the underlying WeakPtr.
 
size_t GetHash () const
 Return a hash value for this instance.
 

Friends

template<class WeakPtr >
WeakPtr TfAnyWeakPtrDynamicCast (const TfAnyWeakPtr &anyWeak, WeakPtr *)
 

Detailed Description

Provides the ability to hold an arbitrary TfWeakPtr in a non-type-specific manner in order to observe whether it has expired or not.

Definition at line 53 of file anyWeakPtr.h.

Member Typedef Documentation

◆ This

typedef TfAnyWeakPtr This

Definition at line 60 of file anyWeakPtr.h.

Constructor & Destructor Documentation

◆ TfAnyWeakPtr() [1/5]

TfAnyWeakPtr ( Ptr const &  ptr)
inline

Construct an AnyWeakPtr watching ptr.

Definition at line 66 of file anyWeakPtr.h.

◆ TfAnyWeakPtr() [2/5]

TfAnyWeakPtr ( )
inline

Construct an AnyWeakPtr not watching any ptr.

Definition at line 73 of file anyWeakPtr.h.

◆ TfAnyWeakPtr() [3/5]

TfAnyWeakPtr ( TfNullPtrType  )
inline

Construct and implicitly convert from TfNullPtr.

Definition at line 80 of file anyWeakPtr.h.

◆ TfAnyWeakPtr() [4/5]

TfAnyWeakPtr ( std::nullptr_t  )
inline

Construct and implicitly convert from std::nullptr_t.

Definition at line 83 of file anyWeakPtr.h.

◆ TfAnyWeakPtr() [5/5]

TfAnyWeakPtr ( TfAnyWeakPtr const &  other)
inline

Definition at line 85 of file anyWeakPtr.h.

◆ ~TfAnyWeakPtr()

~TfAnyWeakPtr ( )
inline

Definition at line 97 of file anyWeakPtr.h.

Member Function Documentation

◆ GetHash()

size_t GetHash ( ) const
inline

Return a hash value for this instance.

Definition at line 150 of file anyWeakPtr.h.

◆ GetType()

TF_API TfType const & GetType ( ) const

Returns the TfType of the underlying WeakPtr.

◆ GetTypeInfo()

TF_API const std::type_info & GetTypeInfo ( ) const

returns the type_info of the underlying WeakPtr

◆ GetUniqueIdentifier()

TF_API void const * GetUniqueIdentifier ( ) const

Return the unique identifier of the WeakPtr this AnyWeakPtr contains.

◆ GetWeakBase()

TF_API TfWeakBase const * GetWeakBase ( ) const

Return the TfWeakBase object of the WeakPtr we are holding.

◆ IsInvalid()

TF_API bool IsInvalid ( ) const

Return true only if this expiry checker is watching a weak pointer which has expired.

◆ operator bool()

TF_API operator bool ( ) const

bool operator

◆ operator!()

TF_API bool operator! ( ) const

operator !

◆ operator!=()

bool operator!= ( const TfAnyWeakPtr rhs) const
inline

inequality operator

Definition at line 121 of file anyWeakPtr.h.

◆ operator<()

TF_API bool operator< ( const TfAnyWeakPtr rhs) const

comparison operator

◆ operator<=()

bool operator<= ( const TfAnyWeakPtr rhs) const
inline

less than or equal operator

Definition at line 129 of file anyWeakPtr.h.

◆ operator=()

TfAnyWeakPtr & operator= ( TfAnyWeakPtr const &  other)
inline

Definition at line 89 of file anyWeakPtr.h.

◆ operator==()

TF_API bool operator== ( const TfAnyWeakPtr rhs) const

equality operator

◆ operator>()

bool operator> ( const TfAnyWeakPtr rhs) const
inline

greater than operator

Definition at line 134 of file anyWeakPtr.h.

◆ operator>=()

bool operator>= ( const TfAnyWeakPtr rhs) const
inline

greater than or equal operator

Definition at line 139 of file anyWeakPtr.h.


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