scopeDescription.h File Reference

#include "pxr/pxr.h"
#include "pxr/base/tf/callContext.h"
#include "pxr/base/tf/preprocessorUtils.h"
#include "pxr/base/tf/stringUtils.h"
#include "pxr/base/tf/api.h"
#include <hboost/optional.hpp>
#include <hboost/preprocessor/if.hpp>
#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(fmt,...)

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

Macro Definition Documentation

#define TF_DESCRIBE_SCOPE	(		fmt,
			...
	)

Value:

TfScopeDescription __scope_description__                                   \
    (HBOOST_PP_IF(TF_NUM_ARGS(__VA_ARGS__),                                     \
                 TfStringPrintf(fmt, __VA_ARGS__), fmt), TF_CALL_CONTEXT)

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 136 of file scopeDescription.h.

Function Documentation

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().