HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
UsdUtilsCoalescingDiagnosticDelegate Class Reference

#include <coalescingDiagnosticDelegate.h>

+ Inheritance diagram for UsdUtilsCoalescingDiagnosticDelegate:

Public Member Functions

USDUTILS_API UsdUtilsCoalescingDiagnosticDelegate ()
 
virtual USDUTILS_API ~UsdUtilsCoalescingDiagnosticDelegate ()
 
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
 
USDUTILS_API void DumpCoalescedDiagnostics (std::ostream &ostr)
 
USDUTILS_API void DumpUncoalescedDiagnostics (std::ostream &ostr)
 
USDUTILS_API
UsdUtilsCoalescingDiagnosticDelegateVector 		TakeCoalescedDiagnostics ()
 
USDUTILS_API std::vector
< std::unique_ptr
< TfDiagnosticBase > > 		TakeUncoalescedDiagnostics ()
 
- Public Member Functions inherited from TfDiagnosticMgr::Delegate
virtual TF_API ~Delegate ()=0
 

Additional Inherited Members

- Protected Member Functions inherited from TfDiagnosticMgr::Delegate
TF_API void _UnhandledAbort () const
 

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.

Constructor & Destructor Documentation

USDUTILS_API UsdUtilsCoalescingDiagnosticDelegate::UsdUtilsCoalescingDiagnosticDelegate ( )
virtual USDUTILS_API UsdUtilsCoalescingDiagnosticDelegate::~UsdUtilsCoalescingDiagnosticDelegate ( )
virtual

Member Function Documentation

USDUTILS_API void UsdUtilsCoalescingDiagnosticDelegate::DumpCoalescedDiagnostics ( std::ostream &  ostr)

Print all pending diagnostics in a coalesced form to ostr

Note
This method clears the pending diagnostics.
USDUTILS_API void UsdUtilsCoalescingDiagnosticDelegate::DumpUncoalescedDiagnostics ( std::ostream &  ostr)

Print all pending diagnostics without any coalescing to ostr

Note
This method clears the pending diagnostics.
virtual USDUTILS_API void UsdUtilsCoalescingDiagnosticDelegate::IssueError ( const TfError &  )
overridevirtual

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

Implements TfDiagnosticMgr::Delegate.

virtual USDUTILS_API void UsdUtilsCoalescingDiagnosticDelegate::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.

virtual USDUTILS_API void UsdUtilsCoalescingDiagnosticDelegate::IssueStatus ( const TfStatus &  status)
overridevirtual

Called when a TF_STATUS() is issued.

Implements TfDiagnosticMgr::Delegate.

virtual USDUTILS_API void UsdUtilsCoalescingDiagnosticDelegate::IssueWarning ( const TfWarning &  warning)
overridevirtual

Called when a TF_WARNING() is issued.

Implements TfDiagnosticMgr::Delegate.

USDUTILS_API UsdUtilsCoalescingDiagnosticDelegateVector UsdUtilsCoalescingDiagnosticDelegate::TakeCoalescedDiagnostics ( )

Get all pending diagnostics in a coalesced form.

Note
This method clears the pending diagnostics.
USDUTILS_API std::vector<std::unique_ptr<TfDiagnosticBase> > UsdUtilsCoalescingDiagnosticDelegate::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: