Inheritance diagram for TraceReporterBase:

Public Types
using	This = TraceReporterBase

using	ThisPtr = TraceReporterBasePtr

using	ThisRefPtr = TraceReporterBaseRefPtr

using	CollectionPtr = std::shared_ptr< TraceCollection >

using	DataSourcePtr = std::unique_ptr< TraceReporterDataSourceBase >

Public Types inherited from TfRefBase
typedef void(*	UniqueChangedFuncPtr )(TfRefBase const *, bool)

Public Member Functions
TRACE_API	TraceReporterBase (DataSourcePtr dataSource)
	Constructor taking ownership of `dataSource`. More...

virtual TRACE_API	~TraceReporterBase ()
	Destructor. More...

TRACE_API bool	SerializeProcessedCollections (std::ostream &ostr) const
	Write all collections that were processed by this reporter to `ostr`. More...

Public Member Functions inherited from TfRefBase
	TfRefBase ()

	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

size_t	GetCurrentCount () const
	Return the current reference count of this object. More...

bool	IsUnique () const
	Return true if only one `TfRefPtr` points to this object. More...

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from TfWeakBase
	TfWeakBase ()

	TfWeakBase (const TfWeakBase &)

const TfWeakBase &	__GetTfWeakBase__ () const

const TfWeakBase &	operator= (const TfWeakBase &)

void	EnableNotification2 () const

TF_API void const *	GetUniqueIdentifier () const

Protected Member Functions
TRACE_API void	_Clear ()
	Removes all references to TraceCollections. More...

TRACE_API void	_Update ()

virtual void	_ProcessCollection (const CollectionPtr &)=0
	Called once per collection from _Update() More...

Protected Member Functions inherited from TfRefBase
virtual TF_API	~TfRefBase ()

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

Additional Inherited Members
Static Public Member Functions inherited from TfRefBase
static TF_API void	SetUniqueChangedListener (UniqueChangedListener listener)

Detailed Description

This class is a base class for report implementations. It handles receiving and processing of TraceCollections.

Definition at line 35 of file reporterBase.h.

Member Typedef Documentation

Definition at line 41 of file reporterBase.h.

Definition at line 42 of file reporterBase.h.

Definition at line 38 of file reporterBase.h.

using TraceReporterBase::ThisPtr = TraceReporterBasePtr

Definition at line 39 of file reporterBase.h.

using TraceReporterBase::ThisRefPtr = TraceReporterBaseRefPtr

Definition at line 40 of file reporterBase.h.

TRACE_API TraceReporterBase::TraceReporterBase ( DataSourcePtr dataSource )

Constructor taking ownership of dataSource.

virtual TRACE_API TraceReporterBase::~TraceReporterBase ( )

virtual

Destructor.

TRACE_API void TraceReporterBase::_Clear ( )

protected

Removes all references to TraceCollections.

virtual void TraceReporterBase::_ProcessCollection ( const CollectionPtr & )

protectedpure virtual

Called once per collection from _Update()

TRACE_API void TraceReporterBase::_Update ( )

protected

Gets the latest data from the TraceCollector singleton and processes all collections that have been received since the last call to _Update().

TRACE_API bool TraceReporterBase::SerializeProcessedCollections ( std::ostream & ostr ) const

Write all collections that were processed by this reporter to ostr.

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