HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
scopeDescription.h File Reference
#include "pxr/pxr.h"
#include "pxr/base/tf/callContext.h"
#include "pxr/base/tf/stringUtils.h"
#include "pxr/base/tf/api.h"
#include <optional>
#include <vector>
#include <string>
+ Include dependency graph for scopeDescription.h:

Go to the source code of this file.

Classes

class  TfScopeDescription
 

Macros

#define TF_DESCRIBE_SCOPE(...)
 

Functions

TF_API std::vector< std::stringTfGetCurrentScopeDescriptionStack ()
 
TF_API std::vector< std::stringTfGetThisThreadScopeDescriptionStack ()
 
template<typename... Args>
std::string Tf_DescribeScopeFormat (const char *fmt, Args &&...args)
 
const char * Tf_DescribeScopeFormat (const char *fmt)
 
std::string && Tf_DescribeScopeFormat (std::string &&fmt)
 
const std::stringTf_DescribeScopeFormat (const std::string &fmt)
 

Macro Definition Documentation

#define TF_DESCRIBE_SCOPE (   ...)
Value:
TfScopeDescription __scope_description__ \
#define TF_CALL_CONTEXT
Definition: callContext.h:47
std::string Tf_DescribeScopeFormat(const char *fmt, Args &&...args)

Macro that accepts either a single string, or printf-style arguments and creates a scope description local variable with the resulting string.

Definition at line 133 of file scopeDescription.h.

Function Documentation

template<typename... Args>
std::string Tf_DescribeScopeFormat ( const char *  fmt,
Args &&...  args 
)
inline

Definition at line 139 of file scopeDescription.h.

const char* Tf_DescribeScopeFormat ( const char *  fmt)
inline

Definition at line 147 of file scopeDescription.h.

std::string&& Tf_DescribeScopeFormat ( std::string &&  fmt)
inline

Definition at line 150 of file scopeDescription.h.

const std::string& Tf_DescribeScopeFormat ( const std::string fmt)
inline

Definition at line 153 of file scopeDescription.h.

TF_API std::vector<std::string> TfGetCurrentScopeDescriptionStack ( )

Return a copy of the current description stack for the "main" thread as identified by ArchGetMainThreadId() as a vector of strings. The most recently pushed description is at back(), and the least recently pushed description is at front().

TF_API std::vector<std::string> TfGetThisThreadScopeDescriptionStack ( )

Return a copy of the current description stack for the current thread of execution as a vector of strings. The most recently pushed description is at back(), and the least recently pushed description is at front().