TraceReporterDataSourceCollector Class Reference

This class is an implementation of TraceReporterDataSourceBase which retrieves TraceCollections from the TraceCollector singleton. More...

+ Inheritance diagram for TraceReporterDataSourceCollector:

Public Types

using This = TraceReporterDataSourceCollector
 
using ThisPtr = TraceReporterDataSourceCollectorPtr
 
using ThisRefPtr = std::unique_ptr< This >
 
- Public Types inherited from TraceReporterDataSourceBase
using CollectionPtr = std::shared_ptr< TraceCollection >
 

Public Member Functions

TRACE_API void Clear () override
 Removes all references to TraceCollections. More...
 
TRACE_API std::vector< CollectionPtr > ConsumeData () override
 Returns the next TraceCollections which need to be processed. More...
 
- Public Member Functions inherited from TraceReporterDataSourceBase
virtual TRACE_API ~TraceReporterDataSourceBase ()
 Destructor. More...
 
- Public Member Functions inherited from TfWeakBase
 TfWeakBase (const TfWeakBase &)
 
const TfWeakBase__GetTfWeakBase__ () const
 
const TfWeakBaseoperator= (const TfWeakBase &)
 
void EnableNotification2 () const
 
TF_API void const * GetUniqueIdentifier () const
 

Static Public Member Functions

static ThisRefPtr New ()
 Creates a new TraceReporterDataSourceCollector. More...
 
static ThisRefPtr New (std::function< bool()> accept)
 Creates a new TraceReporterDataSourceCollector which will only listen to the TraceCollectionAvailable notice when accept returns true. More...
 

Additional Inherited Members

- Protected Member Functions inherited from TfWeakBase
TfRefPtr< Tf_Remnant > _Register () const
 
template<class T >
TfRefPtr< Tf_Remnant > _Register (T *tempRmnt) const
 
bool _HasRemnant () const
 

Detailed Description

This class is an implementation of TraceReporterDataSourceBase which retrieves TraceCollections from the TraceCollector singleton.

Definition at line 51 of file reporterDataSourceCollector.h.

Member Function Documentation

◆ Clear()

TRACE_API void Clear ( )
overridevirtual

Removes all references to TraceCollections.

Implements TraceReporterDataSourceBase.

◆ ConsumeData()

TRACE_API std::vector<CollectionPtr> ConsumeData ( )
overridevirtual

Returns the next TraceCollections which need to be processed.

Implements TraceReporterDataSourceBase.

◆ New() [1/2]

static ThisRefPtr New ( )
inlinestatic

Creates a new TraceReporterDataSourceCollector.

Definition at line 59 of file reporterDataSourceCollector.h.

◆ New() [2/2]

static ThisRefPtr New ( std::function< bool()>  accept)
inlinestatic

Creates a new TraceReporterDataSourceCollector which will only listen to the TraceCollectionAvailable notice when accept returns true.

accept must be thread-safe.

Definition at line 66 of file reporterDataSourceCollector.h.


The documentation for this class was generated from the following file: