IAnalyzer

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

Windows
MacOS
Linux

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

Name Description

Public function Virtual

~IAnalyzer()

Functions

Name Description

Public function Virtual

void

 

OnAnalysisBegin

(
    const FOnAnalysisContext& Context
)

Called when analysis of a trace is beginning.

Public function Virtual

void

 

OnAnalysisEnd()

Indicates that the analysis of a trace log has completed and there are no further events

Public function Virtual

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

Public function Virtual

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.

Public function Virtual

void

 

OnThreadInfo

(
    const FThreadInfo& ThreadInfo
)

Called when information about a thread has been updated.

Classes

Enums

Name

Description

Public enum

EStyle
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss