Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Friends | List of all members
SdfPathTable< MappedType >::NodeHandle Struct Reference

A handle owning a path table node that may be used to "reserve" a stable memory location for key & mapped object. More...

#include <pathTable.h>

Public Member Functions

key_type const & GetKey () const
 Return a const reference to this NodeHandle's key.
 
key_type & GetMutableKey ()
 Return a mutable reference to this NodeHandle's key.
 
mapped_type const & GetMapped () const
 Return a const reference to this NodeHandle's mapped object.
 
mapped_type & GetMutableMapped ()
 Return a mutable reference to this NodeHandle's mapped object.
 
bool IsValid () const
 Return true if this NodeHandle owns a path table entry, false otherwise.
 
 operator bool () const
 Return true if this NodeHandle owns a path table entry, false otherwise.
 
void reset ()
 Delete any owned path table entry.
 

Static Public Member Functions

static NodeHandle New (value_type const &value)
 Create a new NodeHandle for a table entry.
 
static NodeHandle New (value_type &&value)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
static NodeHandle New (key_type const &key, mapped_type const &mapped)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 

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 295 of file pathTable.h.

Member Function Documentation

◆ GetKey()

key_type const & 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 327 of file pathTable.h.

◆ GetMapped()

mapped_type const & 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 341 of file pathTable.h.

◆ GetMutableKey()

key_type & 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 334 of file pathTable.h.

◆ GetMutableMapped()

mapped_type & 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 348 of file pathTable.h.

◆ IsValid()

bool IsValid ( ) const
inline

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

Definition at line 354 of file pathTable.h.

◆ New() [1/3]

static 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 320 of file pathTable.h.

◆ New() [2/3]

static 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 312 of file pathTable.h.

◆ New() [3/3]

static 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 304 of file pathTable.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

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

Definition at line 360 of file pathTable.h.

◆ reset()

void reset ( )
inline

Delete any owned path table entry.

After calling this function, IsValid() returns false.

Definition at line 366 of file pathTable.h.

Friends And Related Function Documentation

◆ SdfPathTable

friend class SdfPathTable
friend

Definition at line 297 of file pathTable.h.

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