All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
errorTransport.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_TRANSPORT
25 #define TF_ERROR_TRANSPORT
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/base/tf/diagnosticMgr.h"
31 #include "pxr/base/arch/hints.h"
32 #include "pxr/base/tf/api.h"
33 
34 PXR_NAMESPACE_OPEN_SCOPE
35 
47 {
48 public:
49  typedef TfDiagnosticMgr::ErrorList ErrorList;
50 
53 
56  void Post() {
57  if (ARCH_UNLIKELY(!IsEmpty()))
58  _PostImpl();
59  }
60 
63  bool IsEmpty() const { return _errorList.empty(); }
64 
68  void swap(TfErrorTransport &other) {
69  _errorList.swap(other._errorList);
70  }
71 
72 private:
73  friend class TfErrorMark;
74 
75  TfErrorTransport(ErrorList &src,
76  ErrorList::iterator first,
77  ErrorList::iterator last) {
78  _errorList.splice(_errorList.begin(), src, first, last);
79  }
80 
81  TF_API
82  void _PostImpl();
83 
84  ErrorList _errorList;
85 };
86 
87 inline void
89 {
90  l.swap(r);
91 }
92 
93 PXR_NAMESPACE_CLOSE_SCOPE
94 
95 #endif // TF_ERROR_TRANSPORT
void swap(ArAssetInfo &lhs, ArAssetInfo &rhs)
Definition: assetInfo.h:60
TfErrorTransport()
Construct an empty TfErrorTransport.
void Post()
Post all contained errors to the current thread's error list, leaving this TfErrorTransport empty...
Class used to record the end of the error-list.
Definition: errorMark.h:66
void swap(TfErrorTransport &other)
Swap this TfErrorTransport's content with other.
bool IsEmpty() const
Return true if this TfErrorTransport contains no errors, false otherwise.
A facility for transporting errors from thread to thread.