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

#include <declareHandles.h>

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

Friends
size_t	hash_value (const This &x)
	Hash.
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 Typedef Documentation

NonConstSpecType

typedef std::remove_const<SpecType>::type NonConstSpecType

Definition at line 68 of file declareHandles.h.

NonConstThis

typedef SdfHandle<NonConstSpecType> NonConstThis

Definition at line 69 of file declareHandles.h.

SpecType

typedef T SpecType

Definition at line 66 of file declareHandles.h.

This

typedef SdfHandle<T> This

Definition at line 65 of file declareHandles.h.

Constructor & Destructor Documentation

SdfHandle() [1/5]

SdfHandle ( )

inline

Definition at line 71 of file declareHandles.h.

SdfHandle() [2/5]

SdfHandle ( TfNullPtrType  )

inline

Definition at line 72 of file declareHandles.h.

SdfHandle() [3/5]

SdfHandle ( const Sdf_IdentityRefPtr &  id )

inlineexplicit

Definition at line 73 of file declareHandles.h.

SdfHandle() [4/5]

SdfHandle ( const SpecType &  spec )

inline

Definition at line 74 of file declareHandles.h.

SdfHandle() [5/5]

SdfHandle ( const SdfHandle< U > &  x )

inline

Definition at line 77 of file declareHandles.h.

Member Function Documentation

GetSpec()

const SpecType & GetSpec ( ) const

inline

Definition at line 104 of file declareHandles.h.

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=() [1/2]

This & operator= ( const SdfHandle< U > &  x )

inline

Definition at line 86 of file declareHandles.h.

operator=() [2/2]

This & operator= ( const This &  x )

inline

Definition at line 79 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.

Reset()

void Reset ( )

inline

Definition at line 109 of file declareHandles.h.

Friends And Related Function Documentation

get_pointer

SpecType * get_pointer ( const SdfHandle< T > &  x )

friend

Definition at line 153 of file declareHandles.h.

hash_value

size_t hash_value ( const This &  x )

friend

Hash.

Definition at line 147 of file declareHandles.h.

SdfHandle

friend class SdfHandle

friend

Definition at line 160 of file declareHandles.h.

---

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

• pxr/usd/sdf/declareHandles.h