Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | List of all members
TfDiagnosticMgr::Delegate Class Referenceabstract

One may set a delegate with the TfDiagnosticMgr which will be called to respond to errors and diagnostics. More...

#include <diagnosticMgr.h>

+ Inheritance diagram for TfDiagnosticMgr::Delegate:

Public Member Functions

virtual void IssueError (TfError const &err)=0
 Called when a TfError is posted.
 
virtual void IssueFatalError (TfCallContext const &context, std::string const &msg)=0
 Called when a TF_FATAL_ERROR is issued (or a failed TF_AXIOM).
 
virtual void IssueStatus (TfStatus const &status)=0
 Called when a TF_STATUS() is issued.
 
virtual void IssueWarning (TfWarning const &warning)=0
 Called when a TF_WARNING() is issued.
 

Protected Member Functions

TF_API void _UnhandledAbort () const
 Abort the program, but avoid the session logging mechanism.
 

Detailed Description

One may set a delegate with the TfDiagnosticMgr which will be called to respond to errors and diagnostics.

Note
None of the methods in TfDiagnosticMgr::Delegate can be reentrant.

Practically speaking, this means they cannot invoke:

  • TF_ERROR
  • TF_RUNTIME_ERROR
  • TF_CODING_ERROR
  • TF_WARN
  • TF_STATUS

For a more complete list, see diagnostic.h

Definition at line 128 of file diagnosticMgr.h.

Member Function Documentation

◆ _UnhandledAbort()

TF_API void _UnhandledAbort ( ) const
protected

Abort the program, but avoid the session logging mechanism.

This is intended to be used for fatal error cases where any information has already been logged.

◆ IssueError()

virtual void IssueError ( TfError const &  err)
pure virtual

Called when a TfError is posted.

Implemented in UsdUtilsCoalescingDiagnosticDelegate, and UsdUtilsConditionalAbortDiagnosticDelegate.

◆ IssueFatalError()

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

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

Implemented in UsdUtilsCoalescingDiagnosticDelegate, and UsdUtilsConditionalAbortDiagnosticDelegate.

◆ IssueStatus()

virtual void IssueStatus ( TfStatus const &  status)
pure virtual

Called when a TF_STATUS() is issued.

Implemented in UsdUtilsCoalescingDiagnosticDelegate, and UsdUtilsConditionalAbortDiagnosticDelegate.

◆ IssueWarning()

virtual void IssueWarning ( TfWarning const &  warning)
pure virtual

Called when a TF_WARNING() is issued.

Implemented in UsdUtilsCoalescingDiagnosticDelegate, and UsdUtilsConditionalAbortDiagnosticDelegate.

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