All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
diagnostic.h File Reference

Diagnostic helpers. More...

+ Include dependency graph for diagnostic.h:

Go to the source code of this file.

Macros

PcpPrimIndex Debugging Output

The following macros are used to annotate the prim indexing process.

The annotations can be output to the terminal or to .dot graphs to allow users to trace the steps in indexing.

#define PCP_INDEXING_PHASE(indexer, node,...)
 Opens a scope indicating a particular phase during prim indexing. More...
 
#define PCP_INDEXING_UPDATE(indexer, node,...)
 Indicates that the prim index currently being constructed has been updated. More...
 
#define PCP_INDEXING_MSG(indexer,...)
 Annotates the current phase of prim indexing with the given message. More...
 

Functions

PCP_API std::string PcpDump (const PcpPrimIndex &primIndex, bool includeInheritOriginInfo=false, bool includeMaps=false)
 
PCP_API std::string PcpDump (const PcpNodeRef &node, bool includeInheritOriginInfo=false, bool includeMaps=false)
 
PCP_API void PcpDumpDotGraph (const PcpPrimIndex &primIndex, const char *filename, bool includeInheritOriginInfo=true, bool includeMaps=false)
 
PCP_API void PcpDumpDotGraph (const PcpNodeRef &node, const char *filename, bool includeInheritOriginInfo=true, bool includeMaps=false)
 

Detailed Description

Diagnostic helpers.

Definition in file diagnostic.h.

Macro Definition Documentation

#define PCP_INDEXING_MSG (   indexer,
  ... 
)
Value:
if (ARCH_UNLIKELY(TfDebug::IsEnabled(PCP_PRIM_INDEX))) { \
Pcp_IndexingMsg(Pcp_ToIndex(indexer), __VA_ARGS__); \
}
static bool IsEnabled(T val)
True if debugging is enabled for the enum value val.
Definition: debug.h:192

Annotates the current phase of prim indexing with the given message.

Definition at line 108 of file diagnostic.h.

#define PCP_INDEXING_PHASE (   indexer,
  node,
  ... 
)
Value:
auto BOOST_PP_CAT(_pcpIndexingPhase, __LINE__) = \
ARCH_UNLIKELY(TfDebug::IsEnabled(PCP_PRIM_INDEX)) ? \
Pcp_IndexingPhaseScope(Pcp_ToIndex(indexer), \
node, TfStringPrintf(__VA_ARGS__)) : \
Pcp_IndexingPhaseScope()
TF_API std::string TfStringPrintf(const char *fmt,...)
Returns a string formed by a printf()-like specification.
static bool IsEnabled(T val)
True if debugging is enabled for the enum value val.
Definition: debug.h:192

Opens a scope indicating a particular phase during prim indexing.

Definition at line 92 of file diagnostic.h.

#define PCP_INDEXING_UPDATE (   indexer,
  node,
  ... 
)
Value:
if (ARCH_UNLIKELY(TfDebug::IsEnabled(PCP_PRIM_INDEX))) { \
Pcp_IndexingUpdate(Pcp_ToIndex(indexer), node, \
TfStringPrintf(__VA_ARGS__)); \
}
TF_API std::string TfStringPrintf(const char *fmt,...)
Returns a string formed by a printf()-like specification.
static bool IsEnabled(T val)
True if debugging is enabled for the enum value val.
Definition: debug.h:192

Indicates that the prim index currently being constructed has been updated.

Definition at line 101 of file diagnostic.h.