HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
collectionNotice.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_COLLECTION_NOTICE_H
26 #define PXR_BASE_TRACE_COLLECTION_NOTICE_H
27 
28 #include "pxr/pxr.h"
29 
30 #include "pxr/base/trace/api.h"
31 #include "pxr/base/tf/notice.h"
33 
35 
36 ///////////////////////////////////////////////////////////////////////////////
37 /// \class TraceCollectionAvailable
38 ///
39 /// A TfNotice that is sent when the TraceCollector creates a TraceCollection.
40 /// This can potentially be sent from multiple threads. Listeners must be
41 /// thread safe.
43 {
44 public:
45  /// Constructor.
46  TraceCollectionAvailable(const std::shared_ptr<TraceCollection>& collection)
47  : _collection(collection)
48  {}
49 
50  /// Destructor.
52 
53  /// Returns the TraceCollection which was produced.
54  const std::shared_ptr<TraceCollection>& GetCollection() const {
55  return _collection;
56  }
57 
58 private:
59  std::shared_ptr<TraceCollection> _collection;
60 };
61 
63 
64 #endif // PXR_BASE_TRACE_COLLECTION_NOTICE_H
const std::shared_ptr< TraceCollection > & GetCollection() const
Returns the TraceCollection which was produced.
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
TraceCollectionAvailable(const std::shared_ptr< TraceCollection > &collection)
Constructor.
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
virtual TRACE_API ~TraceCollectionAvailable()
Destructor.
#define TRACE_API
Definition: api.h:40