coalescingDiagnosticDelegate.h File Reference

A class which provides aggregation of warnings and statuses emitted from Tf's diagnostic management system. More...

+ Include dependency graph for coalescingDiagnosticDelegate.h:

Go to the source code of this file.

Classes

struct  UsdUtilsCoalescingDiagnosticDelegateSharedItem
 The shared component in a coalesced result This type can be thought of as the key by which we coalesce our diagnostics. More...
 
struct  UsdUtilsCoalescingDiagnosticDelegateUnsharedItem
 The unshared component in a coalesced result. More...
 
struct  UsdUtilsCoalescingDiagnosticDelegateItem
 An item used in coalesced results, containing a shared component: the file/function/line number, and a set of unshared components: the call context and commentary. More...
 
class  UsdUtilsCoalescingDiagnosticDelegate
 A class which collects warnings and statuses from the Tf diagnostic manager system in a thread safe manner. More...
 

Typedefs

typedef std::vector< UsdUtilsCoalescingDiagnosticDelegateItemUsdUtilsCoalescingDiagnosticDelegateVector
 A vector of coalesced results, each containing a shared component, the file/function/line number, and a set of unshared components, the call context and commentary. More...
 

Detailed Description

A class which provides aggregation of warnings and statuses emitted from Tf's diagnostic management system.

These diagnostic notifications can be coalesced by invocation point, currently defined as the source file, line number and function name, to recieve a more concise output.

Definition in file coalescingDiagnosticDelegate.h.


Class Documentation

◆ UsdUtilsCoalescingDiagnosticDelegateSharedItem

struct UsdUtilsCoalescingDiagnosticDelegateSharedItem

The shared component in a coalesced result This type can be thought of as the key by which we coalesce our diagnostics.

Definition at line 51 of file coalescingDiagnosticDelegate.h.

Class Members
string sourceFileName
string sourceFunction
size_t sourceLineNumber

◆ UsdUtilsCoalescingDiagnosticDelegateUnsharedItem

struct UsdUtilsCoalescingDiagnosticDelegateUnsharedItem

The unshared component in a coalesced result.

Definition at line 58 of file coalescingDiagnosticDelegate.h.

Class Members
string commentary
TfCallContext context

◆ UsdUtilsCoalescingDiagnosticDelegateItem

struct UsdUtilsCoalescingDiagnosticDelegateItem

An item used in coalesced results, containing a shared component: the file/function/line number, and a set of unshared components: the call context and commentary.

Definition at line 66 of file coalescingDiagnosticDelegate.h.

Class Members
UsdUtilsCoalescingDiagnosticDelegateSharedItem sharedItem
vector< UsdUtilsCoalescingDiagnosticDelegateUnsharedItem > unsharedItems

Typedef Documentation

◆ UsdUtilsCoalescingDiagnosticDelegateVector

A vector of coalesced results, each containing a shared component, the file/function/line number, and a set of unshared components, the call context and commentary.

Definition at line 75 of file coalescingDiagnosticDelegate.h.