IAnalyzer

Interface that users implement to analyze the events in a trace.

Unreal Engine C++ API Reference > Developer > TraceAnalysis > Trace

Inheritance Hierarchy

  • IAnalyzer

References

   
Module TraceAnalysis
Header /Engine/Source/Developer/TraceAnalysis/Public/Trace/Analyzer.h
Include #include "Trace/Analyzer.h"

Syntax

class IAnalyzer  

Remarks

Interface that users implement to analyze the events in a trace. Analysis works by subscribing to events by name along with a user-provider "route" identifier. The IAnalyzer then receives callbacks when those events are encountered along with an interface to query the value of the event's fields.

To analyze a trace, concrete IAnalyzer-derived objects are registered with a FAnalysisContext which is then asked to launch and coordinate the analysis.

Destructors

Type Name Description
  ~IAnalyzer ()  

Functions

Type Name Description
void OnAnalysisBegin ( const FOnAnalysisContext& Context ) Called when analysis of a trace is beginning.
void OnAnalysisEnd () Indicates that the analysis of a trace log has completed and there are no further events
bool OnEvent ( uint16 RouteId, EStyle Style, const FOnEventContext& Context ) For each event subscribed to in OnAnalysisBegin(), the analysis engine will call this method when those events are encountered in a trace log
bool OnNewEvent ( uint16 RouteId, const FEventTypeInfo& TypeInfo ) When a new event type appears in the trace stream, this method is called if the event type has been subscribed to.
void OnThreadInfo ( const FThreadInfo& ThreadInfo ) Called when information about a thread has been updated.

Classes

Type Name Description
Public struct FArrayReader  
Public struct FEventData  
Public struct FEventFieldHandle  
Public struct FEventFieldInfo  
Public struct FEventTime  
Public struct FEventTypeInfo  
Public struct FInterfaceBuilder  
Public struct FOnAnalysisContext  
Public struct FOnEventContext  
Public struct FThreadInfo  
Public struct TArrayReader  

Enums

Type Name Description
Public enum EStyle  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library