HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
threads.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_THREADS_H
26 #define PXR_BASE_TRACE_THREADS_H
27 
28 #include "pxr/pxr.h"
29 #include "pxr/base/trace/api.h"
30 
31 #include <string>
32 
34 
35 ////////////////////////////////////////////////////////////////////////////////
36 /// \class ThraceThreadId
37 ///
38 /// This class represents an identifier for a thread.
39 ///
41 public:
42  /// Constructor which creates an identifier based on std::thread_id. .
43  /// It is either"Main Thread" if this id is marked as the main thread or
44  /// "Thread XXX" where XXX is the string representation of the thread id.
46 
47  /// Constructor which creates an identifier from \p id.
48  TRACE_API explicit TraceThreadId(const std::string& id);
49 
50  /// Returns the string representation of the id.
51  const std::string& ToString() const { return _id; }
52 
53  /// Equality operator.
54  TRACE_API bool operator==(const TraceThreadId&) const;
55 
56  /// Less than operator.
57  TRACE_API bool operator<(const TraceThreadId&) const;
58 private:
59  std::string _id;
60 };
61 
63  return TraceThreadId();
64 }
65 
67 
68 #endif // PXR_BASE_TRACE_THREADS_H
TraceThreadId TraceGetThreadId()
Definition: threads.h:62
const std::string & ToString() const
Returns the string representation of the id.
Definition: threads.h:51
TRACE_API TraceThreadId()
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
TRACE_API bool operator<(const TraceThreadId &) const
Less than operator.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
TRACE_API bool operator==(const TraceThreadId &) const
Equality operator.
#define TRACE_API
Definition: api.h:40