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

Inherits totally_ordered< 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)
TfAnyWeakPtr &	operator= (TfAnyWeakPtr const &other)
TF_API bool	IsInvalid () const
	Return true only if this expiry checker is watching a weak pointer which has expired. More...
TF_API void const *	GetUniqueIdentifier () const
	Return the unique identifier of the WeakPtr this AnyWeakPtr contains. More...
TF_API TfWeakBase const *	GetWeakBase () 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 const &	GetType () 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.

Constructor & Destructor Documentation

TfAnyWeakPtr() [1/4]

TfAnyWeakPtr ( Ptr const &  ptr )

inline

Construct an AnyWeakPtr watching ptr.

Definition at line 67 of file anyWeakPtr.h.

TfAnyWeakPtr() [2/4]

TfAnyWeakPtr ( )

inline

Construct an AnyWeakPtr not watching any ptr.

Definition at line 74 of file anyWeakPtr.h.

TfAnyWeakPtr() [3/4]

TfAnyWeakPtr ( TfNullPtrType  )

inline

Construct and implicitly convert from TfNullPtr.

Definition at line 81 of file anyWeakPtr.h.

TfAnyWeakPtr() [4/4]

TfAnyWeakPtr ( std::nullptr_t  )

inline

Construct and implicitly convert from std::nullptr_t.

Definition at line 84 of file anyWeakPtr.h.

Member Function Documentation

GetHash()

size_t GetHash ( ) const

inline

Return a hash value for this instance.

Definition at line 131 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 !()

TF_API bool operator !

(

)

const

operator !

operator bool()

TF_API operator bool

(

)

const

bool operator

operator<()

TF_API bool operator<

(

const TfAnyWeakPtr &

rhs

)

const

comparison operator

operator==()

TF_API bool operator==

(

const TfAnyWeakPtr &

rhs

)

const

equality operator

---

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

• pxr/base/tf/anyWeakPtr.h