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 terms set forth in the LICENSE.txt file available at
5
// https://openusd.org/license.
6
//
7
#ifndef PXR_BASE_TF_WARNING_H
8
#define PXR_BASE_TF_WARNING_H
9
10
#include "
pxr/pxr.h
"
11
12
#include "
pxr/base/tf/diagnosticBase.h
"
13
14
PXR_NAMESPACE_OPEN_SCOPE
15
16
/// \class TfWarning
17
/// \ingroup group_tf_Diagnostic
18
///
19
/// Represents an object that contains information about a warning.
20
///
21
/// See \ref page_tf_Diagnostic in the C++ API reference for a detailed
22
/// description of the warning issuing API. For a example of how to post a
23
/// warning, see \c TF_WARN(), also in the C++ API reference.
24
///
25
/// In the Python API, you can issue a warning with Tf.Warn().
26
///
27
class
TfWarning
:
public
TfDiagnosticBase
28
{
29
private
:
30
TfWarning
(
TfEnum
warningCode,
char
const
*warningCodeString,
31
TfCallContext
const
&context,
const
std::string& commentary,
32
TfDiagnosticInfo
info,
bool
quiet)
33
:
TfDiagnosticBase
(warningCode, warningCodeString, context,
34
commentary, info, quiet)
35
{ }
36
37
friend
class
TfDiagnosticMgr
;
38
};
39
40
PXR_NAMESPACE_CLOSE_SCOPE
41
42
#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:54
TfEnum
Definition:
enum.h:119
TfDiagnosticInfo
PXR_NAMESPACE_OPEN_SCOPE typedef std::any TfDiagnosticInfo
Definition:
diagnosticBase.h:30
TfCallContext
Definition:
callContext.h:33
pxr.h
TfDiagnosticBase
Definition:
diagnosticBase.h:48
PXR_NAMESPACE_OPEN_SCOPE
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition:
path.h:1425
PXR_NAMESPACE_CLOSE_SCOPE
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition:
pxr.h:74
TfWarning
Definition:
warning.h:27
pxr
base
tf
warning.h
Generated on Wed Aug 27 2025 03:07:51 for HDK by
1.8.6