HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
reporterDataSourceCollector.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_REPORTER_DATA_SOURCE_COLLECTOR_H
26 #define PXR_BASE_TRACE_REPORTER_DATA_SOURCE_COLLECTOR_H
27 
28 #include "pxr/pxr.h"
29 
30 #include "pxr/base/trace/api.h"
34 
36 
37 #include <tbb/concurrent_queue.h>
38 
39 #include <vector>
40 
42 
44 
45 ////////////////////////////////////////////////////////////////////////////////
46 /// \class TraceReporterDataSourceCollector
47 ///
48 /// This class is an implementation of TraceReporterDataSourceBase which
49 /// retrieves TraceCollections from the TraceCollector singleton.
50 ///
53 public:
55  using ThisPtr = TraceReporterDataSourceCollectorPtr;
56  using ThisRefPtr = std::unique_ptr<This>;
57 
58  /// Creates a new TraceReporterDataSourceCollector.
59  static ThisRefPtr New() {
60  return ThisRefPtr(new This());
61  }
62 
63  /// Creates a new TraceReporterDataSourceCollector which will only listen to
64  /// the TraceCollectionAvailable notice when \p accept returns true.
65  /// \p accept must be thread-safe.
66  static ThisRefPtr New(std::function<bool()> accept) {
67  return ThisRefPtr(new This(std::move(accept)));
68  }
69 
70  /// Removes all references to TraceCollections.
71  TRACE_API void Clear() override;
72 
73  /// Returns the next TraceCollections which need to be processed.
74  TRACE_API std::vector<CollectionPtr> ConsumeData() override;
75 
76 private:
78  TRACE_API TraceReporterDataSourceCollector(std::function<bool()> accept);
79 
80  // Add the new collection to the pending queue.
81  void _OnTraceCollection(const TraceCollectionAvailable&);
82 
83  std::function<bool()> _accept;
84  tbb::concurrent_queue<CollectionPtr> _pendingCollections;
85 };
86 
88 
89 #endif // PXR_BASE_TRACE_REPORTER_DATA_SOURCE_COLLECTOR_H
static ThisRefPtr New(std::function< bool()> accept)
TRACE_API void Clear() override
Removes all references to TraceCollections.
TraceReporterDataSourceCollector This
static ThisRefPtr New()
Creates a new TraceReporterDataSourceCollector.
TraceReporterDataSourceCollectorPtr ThisPtr
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_WEAK_PTRS(TraceReporterDataSourceCollector)
TRACE_API std::vector< CollectionPtr > ConsumeData() override
Returns the next TraceCollections which need to be processed.
#define TRACE_API
Definition: api.h:40