HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TfAnyWeakPtr Class Reference

#include <anyWeakPtr.h>

+ Inheritance diagram for TfAnyWeakPtr:

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. More...
 
 TfAnyWeakPtr ()
 Construct an AnyWeakPtr not watching any ptr. More...
 
 TfAnyWeakPtr (TfNullPtrType)
 Construct and implicitly convert from TfNullPtr. More...
 
 TfAnyWeakPtr (std::nullptr_t)
 Construct and implicitly convert from std::nullptr_t. More...
 
 TfAnyWeakPtr (TfAnyWeakPtr const &other)
 
TfAnyWeakPtroperator= (TfAnyWeakPtr const &other)
 
 ~TfAnyWeakPtr ()
 
TF_API bool IsInvalid () const
 
TF_API void constGetUniqueIdentifier () const
 Return the unique identifier of the WeakPtr this AnyWeakPtr contains. More...
 
TF_API TfWeakBase constGetWeakBase () const
 Return the TfWeakBase object of the WeakPtr we are holding. More...
 
TF_API operator bool () const
 bool operator More...
 
TF_API bool operator! () const
 operator ! More...
 
TF_API bool operator== (const TfAnyWeakPtr &rhs) const
 equality operator More...
 
TF_API bool operator< (const TfAnyWeakPtr &rhs) const
 comparison operator More...
 
TF_API const std::type_info & GetTypeInfo () const
 returns the type_info of the underlying WeakPtr More...
 
TF_API TfType constGetType () const
 Returns the TfType of the underlying WeakPtr. More...
 
size_t GetHash () const
 Return a hash value for this instance. More...
 

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 54 of file anyWeakPtr.h.

Member Typedef Documentation

Definition at line 61 of file anyWeakPtr.h.

Constructor & Destructor Documentation

template<class Ptr , class = typename std::enable_if<Tf_SupportsWeakPtr< typename Ptr::DataType>::value>::type>
TfAnyWeakPtr::TfAnyWeakPtr ( Ptr const ptr)
inline

Construct an AnyWeakPtr watching ptr.

Definition at line 67 of file anyWeakPtr.h.

TfAnyWeakPtr::TfAnyWeakPtr ( )
inline

Construct an AnyWeakPtr not watching any ptr.

Definition at line 74 of file anyWeakPtr.h.

TfAnyWeakPtr::TfAnyWeakPtr ( TfNullPtrType  )
inline

Construct and implicitly convert from TfNullPtr.

Definition at line 81 of file anyWeakPtr.h.

TfAnyWeakPtr::TfAnyWeakPtr ( std::nullptr_t  )
inline

Construct and implicitly convert from std::nullptr_t.

Definition at line 84 of file anyWeakPtr.h.

TfAnyWeakPtr::TfAnyWeakPtr ( TfAnyWeakPtr const other)
inline

Definition at line 86 of file anyWeakPtr.h.

TfAnyWeakPtr::~TfAnyWeakPtr ( )
inline

Definition at line 98 of file anyWeakPtr.h.

Member Function Documentation

size_t TfAnyWeakPtr::GetHash ( ) const
inline

Return a hash value for this instance.

Definition at line 131 of file anyWeakPtr.h.

TF_API TfType const& TfAnyWeakPtr::GetType ( ) const

Returns the TfType of the underlying WeakPtr.

TF_API const std::type_info& TfAnyWeakPtr::GetTypeInfo ( ) const

returns the type_info of the underlying WeakPtr

TF_API void const* TfAnyWeakPtr::GetUniqueIdentifier ( ) const

Return the unique identifier of the WeakPtr this AnyWeakPtr contains.

TF_API TfWeakBase const* TfAnyWeakPtr::GetWeakBase ( ) const

Return the TfWeakBase object of the WeakPtr we are holding.

TF_API bool TfAnyWeakPtr::IsInvalid ( ) const

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

TF_API TfAnyWeakPtr::operator bool ( ) const

bool operator

TF_API bool TfAnyWeakPtr::operator! ( ) const

operator !

TF_API bool TfAnyWeakPtr::operator< ( const TfAnyWeakPtr rhs) const

comparison operator

TfAnyWeakPtr& TfAnyWeakPtr::operator= ( TfAnyWeakPtr const other)
inline

Definition at line 90 of file anyWeakPtr.h.

TF_API bool TfAnyWeakPtr::operator== ( const TfAnyWeakPtr rhs) const

equality operator

Friends And Related Function Documentation

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

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