TraceCollection::Visitor Class Referenceabstract

This interface provides a way to access data a TraceCollection. More...

+ Inheritance diagram for TraceCollection::Visitor:

Public Member Functions

virtual TRACE_API ~Visitor ()
 Destructor. More...
 
virtual void OnBeginCollection ()=0
 Called at the beginning of an iteration. More...
 
virtual void OnEndCollection ()=0
 Called at the end of an iteration. More...
 
virtual void OnBeginThread (const TraceThreadId &threadId)=0
 Called before the first event of from the thread with threadId is encountered. More...
 
virtual void OnEndThread (const TraceThreadId &threadId)=0
 Called after the last event of from the thread with threadId is encountered. More...
 
virtual bool AcceptsCategory (TraceCategoryId categoryId)=0
 Called before an event with categoryId is visited. More...
 
virtual void OnEvent (const TraceThreadId &threadId, const TfToken &key, const TraceEvent &event)=0
 Called for every event event with key on thread threadId if AcceptsCategory returns true. More...
 

Detailed Description

This interface provides a way to access data a TraceCollection.

Definition at line 83 of file collection.h.

Constructor & Destructor Documentation

◆ ~Visitor()

virtual TRACE_API ~Visitor ( )
virtual

Destructor.

Member Function Documentation

◆ AcceptsCategory()

virtual bool AcceptsCategory ( TraceCategoryId  categoryId)
pure virtual

Called before an event with categoryId is visited.

If the return value is false, the event will be visited.

◆ OnBeginCollection()

virtual void OnBeginCollection ( )
pure virtual

Called at the beginning of an iteration.

◆ OnBeginThread()

virtual void OnBeginThread ( const TraceThreadId &  threadId)
pure virtual

Called before the first event of from the thread with threadId is encountered.

◆ OnEndCollection()

virtual void OnEndCollection ( )
pure virtual

Called at the end of an iteration.

◆ OnEndThread()

virtual void OnEndThread ( const TraceThreadId &  threadId)
pure virtual

Called after the last event of from the thread with threadId is encountered.

◆ OnEvent()

virtual void OnEvent ( const TraceThreadId &  threadId,
const TfToken key,
const TraceEvent event 
)
pure virtual

Called for every event event with key on thread threadId if AcceptsCategory returns true.


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