HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
status.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 PXR_BASE_TF_STATUS_H
25 #define PXR_BASE_TF_STATUS_H
26 
27 #include "pxr/pxr.h"
28 
30 
32 
33 /// \class TfStatus
34 /// \ingroup group_tf_Diagnostic
35 ///
36 /// Represents an object that contains information about a status message.
37 ///
38 /// See \ref page_tf_Diagnostic in the C++ API reference for a detailed
39 /// description of the status message issuing API. For a example of how to
40 /// post a status message, see \c TF_STATUS(), also in the C++ API reference.
41 ///
42 /// In the Python API, you can issue a status message with Tf.Status().
43 ///
45 {
46 private:
47  TfStatus(TfEnum statusCode, char const *statusCodeString,
48  TfCallContext const &context, const std::string& commentary,
49  TfDiagnosticInfo info, bool quiet)
50  : TfDiagnosticBase(statusCode, statusCodeString, context,
51  commentary, info, quiet)
52  { }
53 
54  friend class TfDiagnosticMgr;
55 };
56 
58 
59 #endif // PXR_BASE_TF_STATUS_H
Definition: enum.h:139
PXR_NAMESPACE_OPEN_SCOPE typedef hboost::any TfDiagnosticInfo
TfDiagnosticBase(TfEnum code, char const *codeString, TfCallContext const &context, const std::string &commentary, TfDiagnosticInfo info, bool quiet)
Construct an instance.
GLsizei const GLchar *const * string
Definition: glew.h:1844
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91