HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
safeTypeCompare.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_SAFE_TYPE_COMPARE_H
25 #define PXR_BASE_TF_SAFE_TYPE_COMPARE_H
26 
27 /// \file tf/safeTypeCompare.h
28 /// \ingroup group_tf_RuntimeTyping
29 /// Safely compare C++ RTTI type structures.
30 
31 #include "pxr/pxr.h"
32 
33 #include <typeinfo>
34 
36 
37 /// Safely compare \c std::type_info structures.
38 ///
39 /// Returns \c true if \p t1 and \p t2 denote the same type.
40 inline bool TfSafeTypeCompare(const std::type_info& t1, const std::type_info& t2) {
41  return t1 == t2;
42 }
43 
44 /// Safely perform a dynamic cast.
45 ///
46 /// Usage should mirror regular \c dynamic_cast:
47 /// \code
48 /// Derived* d = TfSafeDynamic_cast<Derived*>(basePtr);
49 /// \endcode
50 ///
51 /// Note that this function also works with \c TfRefPtr and \c TfWeakPtr
52 /// managed objects.
53 template <typename TO, typename FROM>
54 TO
56  return dynamic_cast<TO>(ptr);
57 }
58 
60 
61 #endif // PXR_BASE_TF_SAFE_TYPE_COMPARE_H
TO TfSafeDynamic_cast(FROM *ptr)
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
const void * ptr(const T *p)
Definition: format.h:3292
GLuint GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat GLfloat t1
Definition: glew.h:12681
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
PXR_NAMESPACE_OPEN_SCOPE bool TfSafeTypeCompare(const std::type_info &t1, const std::type_info &t2)