Navigation
API > API/Developer > API/Developer/TraceAnalysis
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.
| Name | IAnalyzer |
| Type | class |
| Header File | /Engine/Source/Developer/TraceAnalysis/Public/Trace/Analyzer.h |
| Include Path | #include "Trace/Analyzer.h" |
Syntax
class IAnalyzer
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~IAnalyzer() |
Trace/Analyzer.h |
Structs
| Name | Remarks |
|---|---|
| FArrayReader | |
| FEventData | |
| FEventFieldHandle | |
| FEventFieldInfo | |
| FEventTime | |
| FEventTypeInfo | |
| FInterfaceBuilder | |
| FOnAnalysisContext | |
| FOnEventContext | |
| FThreadInfo | |
| TArrayReader |
Enums
Public
| Name | Remarks |
|---|---|
| EStyle |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnAnalysisBegin
(
const FOnAnalysisContext& Context |
Called when analysis of a trace is beginning. | Trace/Analyzer.h | |
virtual void OnAnalysisEnd() |
Indicates that the analysis of a trace log has completed and there are no further events | Trace/Analyzer.h | |
virtual bool OnEvent
(
uint16 RouteId, |
For each event subscribed to in OnAnalysisBegin(), the analysis engine will call this method when those events are encountered in a trace log | Trace/Analyzer.h | |
virtual bool OnNewEvent
(
uint16 RouteId, |
When a new event type appears in the trace stream, this method is called if the event type has been subscribed to. | Trace/Analyzer.h | |
virtual void OnThreadInfo
(
const FThreadInfo& ThreadInfo |
Called when information about a thread has been updated. | Trace/Analyzer.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static ValueType CoerceValue
(
const void* Addr, |
Trace/Analyzer.h |