HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
TraceCollection::Visitor Class Referenceabstract

#include <collection.h>

+ 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
 
virtual void OnEndThread (const TraceThreadId &threadId)=0
 
virtual bool AcceptsCategory (TraceCategoryId categoryId)=0
 
virtual void OnEvent (const TraceThreadId &threadId, const TfToken &key, const TraceEvent &event)=0
 

Detailed Description

This interface provides a way to access data a TraceCollection.

Definition at line 83 of file collection.h.

Constructor & Destructor Documentation

virtual TRACE_API TraceCollection::Visitor::~Visitor ( )
virtual

Destructor.

Member Function Documentation

virtual bool TraceCollection::Visitor::AcceptsCategory ( TraceCategoryId  categoryId)
pure virtual

Called before an event with categoryId is visited. If the return value is false, the event will be visited.

virtual void TraceCollection::Visitor::OnBeginCollection ( )
pure virtual

Called at the beginning of an iteration.

virtual void TraceCollection::Visitor::OnBeginThread ( const TraceThreadId threadId)
pure virtual

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

virtual void TraceCollection::Visitor::OnEndCollection ( )
pure virtual

Called at the end of an iteration.

virtual void TraceCollection::Visitor::OnEndThread ( const TraceThreadId threadId)
pure virtual

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

virtual void TraceCollection::Visitor::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: