HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
reporterDataSourceCollection.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_COLLECTION_H
26 #define PXR_BASE_TRACE_REPORTER_DATA_SOURCE_COLLECTION_H
27 
28 #include "pxr/pxr.h"
29 
30 #include "pxr/base/trace/api.h"
33 
34 #include <vector>
35 
37 
38 ////////////////////////////////////////////////////////////////////////////////
39 /// \class TraceReporterDataSourceCollection
40 ///
41 /// This class is an implementation of TraceReporterDataSourceBase which provides
42 /// access to a set number of TraceCollection instances. This class is useful if
43 /// you want to generate reports from serialized TraceCollections.
44 ///
46 public:
48  using ThisRefPtr = std::unique_ptr<This>;
49 
50  static ThisRefPtr New(CollectionPtr collection) {
51  return ThisRefPtr(new This(collection));
52  }
53  static ThisRefPtr New(std::vector<CollectionPtr> collections) {
54  return ThisRefPtr(new This(std::move(collections)));
55  }
56 
57  /// Removes all references to TraceCollections.
58  TRACE_API void Clear() override;
59 
60  /// Returns the next TraceCollections which need to be processed.
61  TRACE_API std::vector<CollectionPtr> ConsumeData() override;
62 
63 private:
66  std::vector<CollectionPtr> collections);
67 
68  std::vector<CollectionPtr> _data;
69 };
70 
72 
73 #endif // PXR_BASE_TRACE_REPORTER_DATA_SOURCE_COLLECTION_H
shared_ptr< Collection > CollectionPtr
A shared pointer to a Collection.
Definition: Geom.h:53
TraceReporterDataSourceCollection This
static ThisRefPtr New(CollectionPtr collection)
TRACE_API std::vector< CollectionPtr > ConsumeData() override
Returns the next TraceCollections which need to be processed.
TRACE_API void Clear() override
Removes all references to TraceCollections.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1432
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static ThisRefPtr New(std::vector< CollectionPtr > collections)
std::shared_ptr< TraceCollection > CollectionPtr
#define TRACE_API
Definition: api.h:40