UNI_SessionID< LOCAL_ID > Class Template Reference

#include <UNI_SessionID.h>

Inheritance diagram for UNI_SessionID< LOCAL_ID >:

Public Member Functions
	UNI_SessionID (UNI_ID::NumericType id=INVALID_ID)
	Creates a unique global ID from a raw numerical value. More...
	UNI_SessionID (UNI_GraphID graph_id, LOCAL_ID local_id)
UNI_GraphID	graphID () const
	Returns the UNI graph ID encoded in this session ID. More...
LOCAL_ID	localID () const
	Returns the local ID of an item, locating it within the given graph. More...
Public Member Functions inherited from UNI_ID
constexpr	UNI_ID (NumericType id_number=INVALID_ID)
	Explicit constructor. More...
constexpr void	clear ()
	Resets the ID to an invalid value. More...
constexpr NumericType	numericValue () const
	Returns the numeric value of this ID. More...
constexpr exint	exintValue () const
	Returns an exint value of this ID. More...
	operator exint () const
constexpr bool	isValid () const
	Returns true if this ID is valid; false otherwise. More...
constexpr	operator bool () const
	Returns true if this ID is valid; false otherwise. More...
constexpr bool	operator== (const UNI_ID &other) const
	Comparison operators. More...
constexpr bool	operator!= (const UNI_ID &other) const
	Comparison operators. More...
constexpr bool	operator< (const UNI_ID &other) const
	Remaining comparison operators, used for sorting, etc. More...
constexpr bool	operator<= (const UNI_ID &other) const
	Remaining comparison operators, used for sorting, etc. More...
constexpr bool	operator> (const UNI_ID &other) const
	Remaining comparison operators, used for sorting, etc. More...
constexpr bool	operator>= (const UNI_ID &other) const
	Remaining comparison operators, used for sorting, etc. More...

Additional Inherited Members
Public Types inherited from UNI_ID
using	NumericType = exint
	Numerical representation of the ID. More...
Static Public Attributes inherited from UNI_ID
static constexpr NumericType	INVALID_ID = -1
Protected Member Functions inherited from UNI_SessionIDCoder
	UNI_SessionIDCoder (UNI_ID::NumericType session_id_number)
	Creates a unique global ID from a raw numerical value. More...
	UNI_SessionIDCoder (UNI_GraphID graph_id, UNI_ID::NumericType local_id)
UNI_GraphID	decodeGraphID () const
	Returns the graph ID encoded in this session ID. More...
UNI_ID::NumericType	decodeItemID () const
	Returns the numeric value of the item ID encoded in this session ID. More...

Detailed Description

template<typename LOCAL_ID>
class UNI_SessionID< LOCAL_ID >

A convenience class of converting between item's local and session IDs, allowing using the formal ID types like UNI_NodeID (as the template argument).

Definition at line 50 of file UNI_SessionID.h.

Constructor & Destructor Documentation

template<typename LOCAL_ID >

UNI_SessionID< LOCAL_ID >::UNI_SessionID ( UNI_ID::NumericType  id = INVALID_ID )

inlineexplicit

Creates a unique global ID from a raw numerical value.

Definition at line 54 of file UNI_SessionID.h.

template<typename LOCAL_ID >

UNI_SessionID< LOCAL_ID >::UNI_SessionID ( UNI_GraphID  graph_id, LOCAL_ID  local_id  )

inline

Creates a unique ID that gobally identifies the item in Houdini session. The global ID is constructed based on the given graph ID and the item's local ID within that graph.

Definition at line 60 of file UNI_SessionID.h.

Member Function Documentation

template<typename LOCAL_ID >

UNI_GraphID UNI_SessionID< LOCAL_ID >::graphID ( ) const

inline

Returns the UNI graph ID encoded in this session ID.

Definition at line 65 of file UNI_SessionID.h.

template<typename LOCAL_ID >

LOCAL_ID UNI_SessionID< LOCAL_ID >::localID ( ) const

inline

Returns the local ID of an item, locating it within the given graph.

Definition at line 71 of file UNI_SessionID.h.

---

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

• UNI/UNI_SessionID.h