TraceDynamicKey Class Reference

This class stores data used to create dynamic keys which can be referenced in TraceEvent instances. More...

Classes

struct  HashFunctor
 A Hash functor which uses the cached hash which may be used to store keys in a TfHashMap. More...
 

Public Member Functions

 TraceDynamicKey (TfToken name)
 Constructor for TfToken. More...
 
 TraceDynamicKey (const std::string &name)
 Constructor for string. More...
 
 TraceDynamicKey (const char *name)
 Constructor for C string. More...
 
bool operator== (const TraceDynamicKey &other) const
 Equality operator. More...
 
size_t Hash () const
 Return a cached hash code for this key. More...
 
const TraceStaticKeyDataGetData () const
 Returns a reference to TraceStaticKeyData. More...
 

Detailed Description

This class stores data used to create dynamic keys which can be referenced in TraceEvent instances.

Is a key is known at compile time, it is preferable to use a static constexpr TraceStaticKeyData instance instead.

Definition at line 42 of file dynamicKey.h.

Constructor & Destructor Documentation

◆ TraceDynamicKey() [1/3]

TraceDynamicKey ( TfToken  name)
inline

Constructor for TfToken.

Definition at line 45 of file dynamicKey.h.

◆ TraceDynamicKey() [2/3]

TraceDynamicKey ( const std::string &  name)
inline

Constructor for string.

Definition at line 50 of file dynamicKey.h.

◆ TraceDynamicKey() [3/3]

TraceDynamicKey ( const char *  name)
inline

Constructor for C string.

Definition at line 55 of file dynamicKey.h.

Member Function Documentation

◆ GetData()

const TraceStaticKeyData& GetData ( ) const
inline

Returns a reference to TraceStaticKeyData.

Definition at line 78 of file dynamicKey.h.

◆ Hash()

size_t Hash ( ) const
inline

Return a cached hash code for this key.

Definition at line 65 of file dynamicKey.h.

◆ operator==()

bool operator== ( const TraceDynamicKey other) const
inline

Equality operator.

Definition at line 60 of file dynamicKey.h.


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