SdfHandle< T > Class Template Reference

SdfHandle is a smart ptr that calls IsDormant() on the pointed-to object as an extra expiration check so that dormant objects appear to be expired. More...

Inherits totally_ordered< SdfHandle< T > >.

Public Types

typedef SdfHandle< T > This
 
typedef T SpecType
 
typedef std::remove_const< SpecType >::type NonConstSpecType
 
typedef SdfHandle< NonConstSpecType > NonConstThis
 

Public Member Functions

 SdfHandle (TfNullPtrType)
 
 SdfHandle (const Sdf_IdentityRefPtr &id)
 
 SdfHandle (const SpecType &spec)
 
template<class U >
 SdfHandle (const SdfHandle< U > &x)
 
Thisoperator= (const This &x)
 
template<class U >
Thisoperator= (const SdfHandle< U > &x)
 
SpecType * operator-> () const
 Dereference. More...
 
const SpecType & GetSpec () const
 
void Reset ()
 
 operator UnspecifiedBoolType () const
 Returns true in a boolean context if the object is valid, false otherwise. More...
 
bool operator! () const
 Returns false in a boolean context if the object is valid, true otherwise. More...
 
template<class U >
bool operator== (const SdfHandle< U > &other) const
 Compares handles for equality. More...
 
template<class U >
bool operator< (const SdfHandle< U > &other) const
 Arranges handles in an arbitrary strict weak ordering. More...
 

Friends

template<class U >
class SdfHandle
 
size_t hash_value (const This &x)
 Hash. More...
 
SpecType * get_pointer (const SdfHandle &x)
 

Detailed Description

template<class T>
class SdfHandle< T >

SdfHandle is a smart ptr that calls IsDormant() on the pointed-to object as an extra expiration check so that dormant objects appear to be expired.

Definition at line 63 of file declareHandles.h.

Member Function Documentation

◆ operator UnspecifiedBoolType()

operator UnspecifiedBoolType ( ) const
inline

Returns true in a boolean context if the object is valid, false otherwise.

Definition at line 120 of file declareHandles.h.

◆ operator!()

bool operator! ( ) const
inline

Returns false in a boolean context if the object is valid, true otherwise.

Definition at line 126 of file declareHandles.h.

◆ operator->()

SpecType* operator-> ( ) const
inline

Dereference.

Raises a fatal error if the object is invalid or dormant.

Definition at line 94 of file declareHandles.h.

◆ operator<()

bool operator< ( const SdfHandle< U > &  other) const
inline

Arranges handles in an arbitrary strict weak ordering.

Note that this ordering is stable across path changes.

Definition at line 141 of file declareHandles.h.

◆ operator==()

bool operator== ( const SdfHandle< U > &  other) const
inline

Compares handles for equality.

Definition at line 133 of file declareHandles.h.

Friends And Related Function Documentation

◆ hash_value

size_t hash_value ( const This x)
friend

Hash.

Definition at line 147 of file declareHandles.h.


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