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 PXR_BASE_TF_ERROR_H
25 #define PXR_BASE_TF_ERROR_H
26 
27 /// \file tf/error.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/tf/diagnosticBase.h"
31 
32 PXR_NAMESPACE_OPEN_SCOPE
33 
34 class TfDiagnosticMgr;
35 
36 /// \class TfError
37 /// \ingroup group_tf_Diagnostic
38 ///
39 /// Represents an object that contains error information.
40 ///
41 /// See \ref page_tf_Diagnostic in the C++ API reference for a detailed
42 /// description of the error issuing API.  For a example of how to post an
43 /// error, see \c TF_ERROR(), also in the C++ API reference.
44 ///
45 /// In the Python API, you can raise several different types of errors,
46 /// including coding errors (Tf.RaiseCodingError), run time errors
47 /// (Tf.RaiseRuntimeError), fatal errors (Tf.Fatal).
48 ///
49 class TfError: public TfDiagnosticBase {
50 
51 public:
52     /// Return the error code posted.
GetErrorCode()53     TfEnum GetErrorCode() const {
54         return GetDiagnosticCode();
55     }
56 
57     /// Return the diagnostic code posted as a string.
GetErrorCodeAsString()58     const std::string& GetErrorCodeAsString() const {
59         return GetDiagnosticCodeAsString();
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 // PXR_BASE_TF_ERROR_H
73