Loading...
Searching...
No Matches
reporterDataSourceCollector.h
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"
31#include "pxr/base/trace/collection.h"
32#include "pxr/base/trace/collectionNotice.h"
33#include "pxr/base/trace/reporterDataSourceBase.h"
34
36
37#include <tbb/concurrent_queue.h>
38
39#include <vector>
40
41PXR_NAMESPACE_OPEN_SCOPE
42
44
53public:
55 using ThisPtr = TraceReporterDataSourceCollectorPtr;
56 using ThisRefPtr = std::unique_ptr<This>;
57
59 static ThisRefPtr New() {
60 return ThisRefPtr(new This());
61 }
62
66 static ThisRefPtr New(std::function<bool()> accept) {
67 return ThisRefPtr(new This(std::move(accept)));
68 }
69
71 TRACE_API void Clear() override;
72
74 TRACE_API std::vector<CollectionPtr> ConsumeData() override;
75
76private:
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
87PXR_NAMESPACE_CLOSE_SCOPE
88
89#endif // PXR_BASE_TRACE_REPORTER_DATA_SOURCE_COLLECTOR_H
Enable a concrete base class for use with TfWeakPtr.
Definition: weakBase.h:141
A TfNotice that is sent when the TraceCollector creates a TraceCollection.
This class is a base class for TraceReporterBase data sources.
This class is an implementation of TraceReporterDataSourceBase which retrieves TraceCollections from ...
TRACE_API std::vector< CollectionPtr > ConsumeData() override
Returns the next TraceCollections which need to be processed.
static ThisRefPtr New()
Creates a new TraceReporterDataSourceCollector.
TRACE_API void Clear() override
Removes all references to TraceCollections.
static ThisRefPtr New(std::function< bool()> accept)
Creates a new TraceReporterDataSourceCollector which will only listen to the TraceCollectionAvailable...
Standard pointer typedefs.
#define TF_DECLARE_WEAK_PTRS(type)
Define standard weak pointer types.
Definition: declarePtrs.h:62