HDK
Main Page
Related Pages
Modules
Namespaces
Classes
Files
Examples
File List
File Members
All
Classes
Namespaces
Files
Functions
Variables
Typedefs
Enumerations
Enumerator
Friends
Macros
Groups
Pages
warning.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_WARNING_H
25
#define PXR_BASE_TF_WARNING_H
26
27
#include "
pxr/pxr.h
"
28
29
#include "
pxr/base/tf/diagnosticBase.h
"
30
31
PXR_NAMESPACE_OPEN_SCOPE
32
33
/// \class TfWarning
34
/// \ingroup group_tf_Diagnostic
35
///
36
/// Represents an object that contains information about a warning.
37
///
38
/// See \ref page_tf_Diagnostic in the C++ API reference for a detailed
39
/// description of the warning issuing API. For a example of how to post a
40
/// warning, see \c TF_WARN(), also in the C++ API reference.
41
///
42
/// In the Python API, you can issue a warning with Tf.Warn().
43
///
44
class
TfWarning
:
public
TfDiagnosticBase
45
{
46
private
:
47
TfWarning
(
TfEnum
warningCode,
char
const
*warningCodeString,
48
TfCallContext
const
&context,
const
std::string
& commentary,
49
TfDiagnosticInfo
info,
bool
quiet)
50
:
TfDiagnosticBase
(warningCode, warningCodeString, context,
51
commentary, info, quiet)
52
{ }
53
54
friend
class
TfDiagnosticMgr
;
55
};
56
57
PXR_NAMESPACE_CLOSE_SCOPE
58
59
#endif // PXR_BASE_TF_WARNING_H
diagnosticBase.h
TfDiagnosticBase::TfDiagnosticBase
TF_API TfDiagnosticBase(TfEnum code, char const *codeString, TfCallContext const &context, const std::string &commentary, TfDiagnosticInfo info, bool quiet)
Construct an instance.
TfDiagnosticMgr
Definition:
diagnosticMgr.h:71
string
GLsizei const GLchar *const * string
Definition:
glcorearb.h:814
TfEnum
Definition:
enum.h:136
TfDiagnosticInfo
PXR_NAMESPACE_OPEN_SCOPE typedef std::any TfDiagnosticInfo
Definition:
diagnosticBase.h:47
TfCallContext
Definition:
callContext.h:50
pxr.h
TfDiagnosticBase
Definition:
diagnosticBase.h:65
PXR_NAMESPACE_OPEN_SCOPE
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition:
path.h:1432
PXR_NAMESPACE_CLOSE_SCOPE
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition:
pxr.h:91
TfWarning
Definition:
warning.h:44
pxr
base
tf
warning.h
Generated on Tue Oct 8 2024 02:43:30 for HDK by
1.8.6