This class is a base class for report implementations. More...

#include <reporterBase.h>

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`.

virtual TRACE_API	~TraceReporterBase ()
	Destructor.

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

Public Member Functions inherited from TfRefBase
	TfRefBase (TfRefBase const &)

TfRefBase &	operator= (TfRefBase const &)

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

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

void	SetShouldInvokeUniqueChangedListener (bool shouldCall)

Public Member Functions inherited from 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.

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

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

Protected Member Functions inherited from 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 52 of file reporterBase.h.

Member Typedef Documentation

◆ CollectionPtr

using CollectionPtr = std::shared_ptr<TraceCollection>

Definition at line 58 of file reporterBase.h.

◆ DataSourcePtr

using DataSourcePtr = std::unique_ptr<TraceReporterDataSourceBase>

Definition at line 59 of file reporterBase.h.

◆ This

using This = TraceReporterBase

Definition at line 55 of file reporterBase.h.

◆ ThisPtr

using ThisPtr = TraceReporterBasePtr

Definition at line 56 of file reporterBase.h.

◆ ThisRefPtr

using ThisRefPtr = TraceReporterBaseRefPtr

Definition at line 57 of file reporterBase.h.

Constructor & Destructor Documentation

◆ TraceReporterBase()

TRACE_API TraceReporterBase ( DataSourcePtr dataSource )

Constructor taking ownership of dataSource.

◆ ~TraceReporterBase()

virtual TRACE_API ~TraceReporterBase ( )

virtual

Destructor.

Member Function Documentation

◆ _Clear()

TRACE_API void _Clear ( )

protected

Removes all references to TraceCollections.

◆ _ProcessCollection()

virtual void _ProcessCollection ( const CollectionPtr & )

protectedpure virtual

Called once per collection from _Update()

◆ _Update()

TRACE_API void _Update ( )

protected

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

◆ SerializeProcessedCollections()

TRACE_API bool 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:

pxr/base/trace/reporterBase.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members