All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TraceReporterDataSourceCollector Class Reference

#include <reporterDataSourceCollector.h>

+ 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 ()
 TfWeakBase (const TfWeakBase &)
const TfWeakBase__GetTfWeakBase__ () const
const TfWeakBaseoperator= (const TfWeakBase &)
void EnableNotification2 () const
TF_API void constGetUniqueIdentifier () const

Static Public Member Functions

static ThisRefPtr New ()
 Creates a new TraceReporterDataSourceCollector. More...
static ThisRefPtr New (std::function< bool()> accept)

Additional Inherited Members

- Protected Member Functions inherited from TfWeakBase
 ~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 Typedef Documentation

using TraceReporterDataSourceCollector::ThisPtr = TraceReporterDataSourceCollectorPtr

Definition at line 55 of file reporterDataSourceCollector.h.

Definition at line 56 of file reporterDataSourceCollector.h.

Member Function Documentation

TRACE_API void TraceReporterDataSourceCollector::Clear ( )

Removes all references to TraceCollections.

Implements TraceReporterDataSourceBase.

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

Returns the next TraceCollections which need to be processed.

Implements TraceReporterDataSourceBase.

static ThisRefPtr TraceReporterDataSourceCollector::New ( )

Creates a new TraceReporterDataSourceCollector.

Definition at line 59 of file reporterDataSourceCollector.h.

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

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: