All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
error.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef PXR_BASE_TF_ERROR_H
8#define PXR_BASE_TF_ERROR_H
9
11
12#include "pxr/pxr.h"
14
15PXR_NAMESPACE_OPEN_SCOPE
16
17class TfDiagnosticMgr;
18
33
34public:
37 return GetDiagnosticCode();
38 }
39
41 const std::string& GetErrorCodeAsString() const {
43 }
44
45private:
46 TfError(TfEnum errorCode, char const *errCodeString,
47 TfCallContext const &context, const std::string& commentary,
48 TfDiagnosticInfo info, bool quiet);
49
50 friend class TfDiagnosticMgr;
51};
52
53PXR_NAMESPACE_CLOSE_SCOPE
54
55#endif // PXR_BASE_TF_ERROR_H
Represents the base class of an object representing a diagnostic message.
const std::string & GetDiagnosticCodeAsString() const
Return the diagnostic code posted as a string.
TfEnum GetDiagnosticCode() const
Return the diagnostic code posted.
Singleton class through which all errors and diagnostics pass.
Definition: diagnosticMgr.h:54
An enum class that records both enum type and enum value.
Definition: enum.h:120
Represents an object that contains error information.
Definition: error.h:32
TfEnum GetErrorCode() const
Return the error code posted.
Definition: error.h:36
const std::string & GetErrorCodeAsString() const
Return the diagnostic code posted as a string.
Definition: error.h:41