All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
reporterDataSourceBase.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 TRACE_REPORTER_DATA_SOURCE_BASE_H
26 #define TRACE_REPORTER_DATA_SOURCE_BASE_H
27 
28 #include "pxr/pxr.h"
29 
30 #include "pxr/base/trace/api.h"
31 #include "pxr/base/trace/collection.h"
32 
33 #include <vector>
34 
35 PXR_NAMESPACE_OPEN_SCOPE
36 
45 public:
46  using CollectionPtr = std::shared_ptr<TraceCollection>;
47 
49  TRACE_API virtual ~TraceReporterDataSourceBase();
50 
52  virtual void Clear() = 0;
53 
55  virtual std::vector<CollectionPtr> ConsumeData() = 0;
56 };
57 
58 PXR_NAMESPACE_CLOSE_SCOPE
59 
60 #endif // TRACE_REPORTER_DATA_SOURCE_BASE_H
virtual TRACE_API ~TraceReporterDataSourceBase()
Destructor.
This class is a base class for TraceReporterBase data sources.
virtual void Clear()=0
Removes all references to TraceCollections.
virtual std::vector< CollectionPtr > ConsumeData()=0
Returns the next TraceCollections which need to be processed.