This class holds data necessary to create keys for TraceEvent instances. More...

#include <staticKeyData.h>

Classes
class	StringLiteral
	This is a helper class for the constructors of TraceStaticKeyData. More...

Public Member Functions
constexpr	TraceStaticKeyData (const StringLiteral name)
	Constructor for a `name`.

constexpr	TraceStaticKeyData (const StringLiteral func, const StringLiteral prettyFunc, const StringLiteral name=StringLiteral())
	Constructor for a function (`func`, `prettyFunc`) and optional scope `name`.

TRACE_API bool	operator== (const TraceStaticKeyData &other) const
	Equality comparison. Inequality is also defined.

bool	operator!= (const TraceStaticKeyData &other) const

TRACE_API std::string	GetString () const
	Returns the string representation of the key data.

Friends
class	TraceDynamicKey

Detailed Description

This class holds data necessary to create keys for TraceEvent instances.

This class is meant to be used as constexpr static data.

Definition at line 43 of file staticKeyData.h.

Constructor & Destructor Documentation

◆ TraceStaticKeyData() [1/2]

constexpr TraceStaticKeyData ( const StringLiteral name )

inlineconstexpr

Constructor for a name.

Definition at line 65 of file staticKeyData.h.

◆ TraceStaticKeyData() [2/2]

constexpr TraceStaticKeyData	(	const StringLiteral	func,
		const StringLiteral	prettyFunc,
		const StringLiteral	name = `StringLiteral()`
	)

inlineconstexpr

Constructor for a function (func, prettyFunc) and optional scope name.

Definition at line 70 of file staticKeyData.h.

Member Function Documentation

◆ GetString()

TRACE_API std::string GetString ( ) const

Returns the string representation of the key data.

◆ operator!=()

bool operator!= ( const TraceStaticKeyData & other ) const

inline

Definition at line 82 of file staticKeyData.h.

◆ operator==()

TRACE_API bool operator== ( const TraceStaticKeyData & other ) const

Equality comparison. Inequality is also defined.

Friends And Related Function Documentation

◆ TraceDynamicKey

friend class TraceDynamicKey

friend

Definition at line 97 of file staticKeyData.h.

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

pxr/base/trace/staticKeyData.h

Classes

Public Member Functions

Friends