SdfPathTable< MappedType >::NodeHandle Struct Reference

#include <pathTable.h>

Public Member Functions
key_type const &	GetKey () const
key_type &	GetMutableKey ()
mapped_type const &	GetMapped () const
mapped_type &	GetMutableMapped ()
bool	IsValid () const
	operator bool () const
void	reset ()

Static Public Member Functions
static NodeHandle	New (value_type const &value)
static NodeHandle	New (value_type &&value)
static NodeHandle	New (key_type const &key, mapped_type const &mapped)

Friends
class	SdfPathTable

Detailed Description

template<class MappedType>
struct SdfPathTable< MappedType >::NodeHandle

A handle owning a path table node that may be used to "reserve" a stable memory location for key & mapped object. A node handle may be inserted into a table later, and if that insertion is successful, the underlying key & mapped object remain at the same memory location.

Definition at line 301 of file pathTable.h.

Member Function Documentation

template<class MappedType>

key_type const& SdfPathTable< MappedType >::NodeHandle::GetKey ( ) const

inline

Return a const reference to this NodeHandle's key. This NodeHandle must be valid to call this member function (see NodeHandle::IsValid).

Definition at line 333 of file pathTable.h.

template<class MappedType>

mapped_type const& SdfPathTable< MappedType >::NodeHandle::GetMapped ( ) const

inline

Return a const reference to this NodeHandle's mapped object. This NodeHandle must be valid to call this member function (see NodeHandle::IsValid).

Definition at line 347 of file pathTable.h.

template<class MappedType>

key_type& SdfPathTable< MappedType >::NodeHandle::GetMutableKey ( )

inline

Return a mutable reference to this NodeHandle's key. This NodeHandle must be valid to call this member function (see NodeHandle::IsValid).

Definition at line 340 of file pathTable.h.

template<class MappedType>

mapped_type& SdfPathTable< MappedType >::NodeHandle::GetMutableMapped ( )

inline

Return a mutable reference to this NodeHandle's mapped object. This NodeHandle must be valid to call this member function (see NodeHandle::IsValid).

Definition at line 354 of file pathTable.h.

template<class MappedType>

bool SdfPathTable< MappedType >::NodeHandle::IsValid ( ) const

inline

Return true if this NodeHandle owns a path table entry, false otherwise.

Definition at line 360 of file pathTable.h.

template<class MappedType>

static NodeHandle SdfPathTable< MappedType >::NodeHandle::New ( value_type const &  value )

inlinestatic

Create a new NodeHandle for a table entry. This NodeHandle can later be inserted into an SdfPathTable. If inserted successfully, the key and value addresses remain valid. NodeHandles may be created concurrently without additional synchronization.

Definition at line 310 of file pathTable.h.

template<class MappedType>

static NodeHandle SdfPathTable< MappedType >::NodeHandle::New ( value_type &&  value )

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 318 of file pathTable.h.

template<class MappedType>

static NodeHandle SdfPathTable< MappedType >::NodeHandle::New ( key_type const &  key, mapped_type const &  mapped  )

inlinestatic

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 326 of file pathTable.h.

template<class MappedType>

SdfPathTable< MappedType >::NodeHandle::operator bool ( ) const

inlineexplicit

Return true if this NodeHandle owns a path table entry, false otherwise.

Definition at line 366 of file pathTable.h.

template<class MappedType>

void SdfPathTable< MappedType >::NodeHandle::reset ( void  )

inline

Delete any owned path table entry. After calling this function, IsValid() returns false.

Definition at line 372 of file pathTable.h.

Friends And Related Function Documentation

template<class MappedType>

friend class SdfPathTable

friend

Definition at line 303 of file pathTable.h.

---

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

• pxr/usd/sdf/pathTable.h