All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
error.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef TF_ERROR_H
25 #define TF_ERROR_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/tf/diagnosticBase.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 class TfDiagnosticMgr;
35 
49 class TfError: public TfDiagnosticBase {
50 
51 public:
53  TfEnum GetErrorCode() const {
54  return GetDiagnosticCode();
55  }
56 
58  const std::string& GetErrorCodeAsString() const {
60  }
61 
62 private:
63  TfError(TfEnum errorCode, char const *errCodeString,
64  TfCallContext const &context, const std::string& commentary,
65  TfDiagnosticInfo info, bool quiet);
66 
67  friend class TfDiagnosticMgr;
68 };
69 
70 PXR_NAMESPACE_CLOSE_SCOPE
71 
72 #endif // TF_ERROR_H
Singleton class through which all errors and diagnostics pass.
Definition: diagnosticMgr.h:70
TfEnum GetErrorCode() const
Return the error code posted.
Definition: error.h:53
const std::string & GetDiagnosticCodeAsString() const
Return the diagnostic code posted as a string.
An enum class that records both enum type and enum value.
Definition: enum.h:140
const std::string & GetErrorCodeAsString() const
Return the diagnostic code posted as a string.
Definition: error.h:58
Represents the base class of an object representing a diagnostic message.
Represents an object that contains error information.
Definition: error.h:49
TfEnum GetDiagnosticCode() const
Return the diagnostic code posted.