A lightweight identifier that may be used to identify a particular cached stage within a UsdStageCache. More...
Inherits totally_ordered< Id >.
Public Member Functions | |
Id () | |
Default construct an invalid id. More... | |
long int | ToLongInt () const |
Convert this Id to an integral representation. More... | |
std::string | ToString () const |
Convert this Id to a string representation. More... | |
bool | IsValid () const |
Return true if this Id is valid. More... | |
operator bool () const | |
Return true if this Id is valid. More... | |
Static Public Member Functions | |
static Id | FromLongInt (long int val) |
Create an Id from an integral value. More... | |
static Id | FromString (const std::string &s) |
Create an Id from a string value. More... | |
Friends | |
bool | operator== (const Id &lhs, const Id &rhs) |
Equality comparison. More... | |
bool | operator< (const Id &lhs, const Id &rhs) |
Less-than comparison. More... | |
size_t | hash_value (Id id) |
Hash. More... | |
A lightweight identifier that may be used to identify a particular cached stage within a UsdStageCache.
An identifier may be converted to and from long int and string, to facilitate use within restricted contexts.
Id objects are only valid with the stage from which they were obtained. It never makes sense to use an Id with a stage other than the one it was obtained from.
Definition at line 100 of file stageCache.h.
|
inline |
Default construct an invalid id.
Definition at line 102 of file stageCache.h.
|
inlinestatic |
Create an Id from an integral value.
The supplied val
must have been obtained by calling ToLongInt() previously.
Definition at line 106 of file stageCache.h.
|
inlinestatic |
Create an Id from a string value.
The supplied val
must have been obtained by calling ToString() previously.
Definition at line 110 of file stageCache.h.
|
inline |
Return true if this Id is valid.
Definition at line 123 of file stageCache.h.
|
inlineexplicit |
Return true if this Id is valid.
Definition at line 126 of file stageCache.h.
|
inline |
Convert this Id to an integral representation.
Definition at line 115 of file stageCache.h.
|
inline |
Convert this Id to a string representation.
Definition at line 118 of file stageCache.h.
|
friend |
Hash.
Definition at line 138 of file stageCache.h.
Less-than comparison.
Definition at line 134 of file stageCache.h.
Equality comparison.
Definition at line 130 of file stageCache.h.