HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
key.h
Go to the documentation of this file.
1 //
2 // Copyright 2018 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 
25 #ifndef PXR_BASE_TRACE_KEY_H
26 #define PXR_BASE_TRACE_KEY_H
27 
28 #include "pxr/pxr.h"
30 
31 
33 
34 ////////////////////////////////////////////////////////////////////////////////
35 /// \class TraceKey
36 ///
37 /// A wrapper around a TraceStaticKeyData pointer that is stored in TraceEvent
38 /// instances.
39 ///
40 class TraceKey {
41 public:
42  /// Constructor.
43  constexpr TraceKey(const TraceStaticKeyData& data) : _ptr(&data) {}
44 
45  /// Equality comparison.
46  bool operator == (const TraceKey& other) const {
47  if (_ptr == other._ptr) {
48  return true;
49  } else {
50  return *_ptr == *other._ptr;
51  }
52  }
53 
54  /// Hash function.
55  size_t Hash() const {
56  return reinterpret_cast<size_t>(_ptr)/sizeof(TraceStaticKeyData);
57  }
58 
59  /// A Hash functor which may be used to store keys in a TfHashMap.
60  struct HashFunctor {
61  size_t operator()(const TraceKey& key) const {
62  return key.Hash();
63  }
64  };
65 
66 private:
67  const TraceStaticKeyData* _ptr;
68 
69  // TraceCollection converts TraceKeys to TfTokens for visitors.
70  friend class TraceCollection;
71 };
72 
74 
75 #endif // PXR_BASE_TRACE_KEY_H
size_t operator()(const TraceKey &key) const
Definition: key.h:61
bool operator==(const TraceKey &other) const
Equality comparison.
Definition: key.h:46
A Hash functor which may be used to store keys in a TfHashMap.
Definition: key.h:60
constexpr TraceKey(const TraceStaticKeyData &data)
Constructor.
Definition: key.h:43
GLboolean * data
Definition: glcorearb.h:130
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
size_t Hash() const
Hash function.
Definition: key.h:55
Definition: key.h:40