All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TfError Class Reference

#include <error.h>

+ Inheritance diagram for TfError:

Public Member Functions

TfEnum GetErrorCode () const
 Return the error code posted. More...
const std::stringGetErrorCodeAsString () const
 Return the diagnostic code posted as a string. More...
- Public Member Functions inherited from TfDiagnosticBase
const TfCallContextGetContext () const
 Return the call context where the message was issued. More...
std::string GetSourceFileName () const
 Return the source file name that the diagnostic message was posted from. More...
size_t GetSourceLineNumber () const
std::string constGetCommentary () const
 Return the commentary string describing this diagnostic message. More...
std::string GetSourceFunction () const
 Return the source function that the diagnostic message was posted from. More...
void AugmentCommentary (const std::string &s)
TfEnum GetDiagnosticCode () const
 Return the diagnostic code posted. More...
const std::stringGetDiagnosticCodeAsString () const
template<typename T >
const TGetInfo () const
void SetInfo (TfDiagnosticInfo any)
bool GetQuiet () const
std::string GetPrettyPrintString () const
 Return the commentary string. More...
bool IsFatal () const
 Return true if this diagnostic's code is a fatal code. More...
bool IsCodingError () const
 TfDiagnosticBase (TfEnum code, char const *codeString, TfCallContext const &context, const std::string &commentary, TfDiagnosticInfo info, bool quiet)
 Construct an instance. More...


class TfDiagnosticMgr

Additional Inherited Members

- Protected Attributes inherited from TfDiagnosticBase
TfCallContext _context
std::string _commentary
TfEnum _code
std::string _codeString
TfDiagnosticInfo _info
size_t _serial = 0
bool _quiet = false

Detailed Description

Represents an object that contains error information.

See page_tf_Diagnostic in the C++ API reference for a detailed description of the error issuing API. For a example of how to post an error, see TF_ERROR(), also in the C++ API reference.

In the Python API, you can raise several different types of errors, including coding errors (Tf.RaiseCodingError), run time errors (Tf.RaiseRuntimeError), fatal errors (Tf.Fatal).

Definition at line 49 of file error.h.

Member Function Documentation

TfEnum TfError::GetErrorCode ( ) const

Return the error code posted.

Definition at line 53 of file error.h.

const std::string& TfError::GetErrorCodeAsString ( ) const

Return the diagnostic code posted as a string.

Definition at line 58 of file error.h.

Friends And Related Function Documentation

friend class TfDiagnosticMgr

Definition at line 67 of file error.h.

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