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: TfWarning(TfEnum warningCode,char const * warningCodeString,TfCallContext const & context,const std::string & commentary,TfDiagnosticInfo info,bool quiet)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 60