UsdUtilsCoalescingDiagnosticDelegate Class Reference

A class which collects warnings and statuses from the Tf diagnostic manager system in a thread safe manner. More...

+ Inheritance diagram for UsdUtilsCoalescingDiagnosticDelegate:

Public Member Functions

virtual USDUTILS_API void IssueError (const TfError &) override
 Methods that implement the interface provided in TfDiagnosticMgr::Delegate. More...
 
virtual USDUTILS_API void IssueStatus (const TfStatus &) override
 Called when a TF_STATUS() is issued. More...
 
virtual USDUTILS_API void IssueWarning (const TfWarning &) override
 Called when a TF_WARNING() is issued. More...
 
virtual USDUTILS_API void IssueFatalError (const TfCallContext &, const std::string &) override
 Called when a TF_FATAL_ERROR is issued (or a failed TF_AXIOM). More...
 
USDUTILS_API void DumpCoalescedDiagnostics (std::ostream &ostr)
 Print all pending diagnostics in a coalesced form to ostr. More...
 
USDUTILS_API void DumpUncoalescedDiagnostics (std::ostream &ostr)
 Print all pending diagnostics without any coalescing to ostr. More...
 
USDUTILS_API UsdUtilsCoalescingDiagnosticDelegateVector TakeCoalescedDiagnostics ()
 Get all pending diagnostics in a coalesced form. More...
 
USDUTILS_API std::vector< std::unique_ptr< TfDiagnosticBase > > TakeUncoalescedDiagnostics ()
 Get all pending diagnostics without any coalescing. More...
 

Additional Inherited Members

- Protected Member Functions inherited from TfDiagnosticMgr::Delegate
TF_API void _UnhandledAbort () const
 Abort the program, but avoid the session logging mechanism. More...
 

Detailed Description

A class which collects warnings and statuses from the Tf diagnostic manager system in a thread safe manner.

This class allows clients to get both the unfiltered results, as well as a compressed view which deduplicates diagnostic events by their source line number, function and file from which they occurred.

Definition at line 84 of file coalescingDiagnosticDelegate.h.

Member Function Documentation

◆ DumpCoalescedDiagnostics()

USDUTILS_API void DumpCoalescedDiagnostics ( std::ostream &  ostr)

Print all pending diagnostics in a coalesced form to ostr.

Note
This method clears the pending diagnostics.

◆ DumpUncoalescedDiagnostics()

USDUTILS_API void DumpUncoalescedDiagnostics ( std::ostream &  ostr)

Print all pending diagnostics without any coalescing to ostr.

Note
This method clears the pending diagnostics.

◆ IssueError()

virtual USDUTILS_API void IssueError ( const TfError )
overridevirtual

Methods that implement the interface provided in TfDiagnosticMgr::Delegate.

Implements TfDiagnosticMgr::Delegate.

◆ IssueFatalError()

virtual USDUTILS_API void IssueFatalError ( const TfCallContext &  context,
const std::string &  msg 
)
overridevirtual

Called when a TF_FATAL_ERROR is issued (or a failed TF_AXIOM).

Implements TfDiagnosticMgr::Delegate.

◆ IssueStatus()

virtual USDUTILS_API void IssueStatus ( const TfStatus status)
overridevirtual

Called when a TF_STATUS() is issued.

Implements TfDiagnosticMgr::Delegate.

◆ IssueWarning()

virtual USDUTILS_API void IssueWarning ( const TfWarning warning)
overridevirtual

Called when a TF_WARNING() is issued.

Implements TfDiagnosticMgr::Delegate.

◆ TakeCoalescedDiagnostics()

USDUTILS_API UsdUtilsCoalescingDiagnosticDelegateVector TakeCoalescedDiagnostics ( )

Get all pending diagnostics in a coalesced form.

Note
This method clears the pending diagnostics.

◆ TakeUncoalescedDiagnostics()

USDUTILS_API std::vector<std::unique_ptr<TfDiagnosticBase> > TakeUncoalescedDiagnostics ( )

Get all pending diagnostics without any coalescing.

Note
This method clears the pending diagnostics.

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