TfAnyWeakPtr Class Reference

#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. 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)
	~TfAnyWeakPtr ()
TF_API bool	IsInvalid () const
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...
bool	operator!= (const TfAnyWeakPtr &rhs) const
	inequality operator More...
TF_API bool	operator< (const TfAnyWeakPtr &rhs) const
	comparison operator More...
bool	operator<= (const TfAnyWeakPtr &rhs) const
	less than or equal operator More...
bool	operator> (const TfAnyWeakPtr &rhs) const
	greater than operator More...
bool	operator>= (const TfAnyWeakPtr &rhs) const
	greater than or equal 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 53 of file anyWeakPtr.h.

Member Typedef Documentation

typedef TfAnyWeakPtr TfAnyWeakPtr::This

Definition at line 60 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 66 of file anyWeakPtr.h.

TfAnyWeakPtr::TfAnyWeakPtr ( )

inline

Construct an AnyWeakPtr not watching any ptr.

Definition at line 73 of file anyWeakPtr.h.

TfAnyWeakPtr::TfAnyWeakPtr ( TfNullPtrType  )

inline

Construct and implicitly convert from TfNullPtr.

Definition at line 80 of file anyWeakPtr.h.

TfAnyWeakPtr::TfAnyWeakPtr ( std::nullptr_t  )

inline

Construct and implicitly convert from std::nullptr_t.

Definition at line 83 of file anyWeakPtr.h.

TfAnyWeakPtr::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

size_t TfAnyWeakPtr::GetHash ( ) const

inline

Return a hash value for this instance.

Definition at line 150 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 !

bool TfAnyWeakPtr::operator!= ( const TfAnyWeakPtr &  rhs ) const

inline

inequality operator

Definition at line 121 of file anyWeakPtr.h.

TF_API bool TfAnyWeakPtr::operator<

(

const TfAnyWeakPtr &

rhs

)

const

comparison operator

bool TfAnyWeakPtr::operator<= ( const TfAnyWeakPtr &  rhs ) const

inline

less than or equal operator

Definition at line 129 of file anyWeakPtr.h.

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

inline

Definition at line 89 of file anyWeakPtr.h.

TF_API bool TfAnyWeakPtr::operator==

(

const TfAnyWeakPtr &

rhs

)

const

equality operator

bool TfAnyWeakPtr::operator> ( const TfAnyWeakPtr &  rhs ) const

inline

greater than operator

Definition at line 134 of file anyWeakPtr.h.

bool TfAnyWeakPtr::operator>= ( const TfAnyWeakPtr &  rhs ) const

inline

greater than or equal operator

Definition at line 139 of file anyWeakPtr.h.

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:

• pxr/base/tf/anyWeakPtr.h