TTimingEventSearch

Helper used to orchestrate a search of a timing event track's events Example of usage: FMyStruct MatchedPayload;

Windows
MacOS
Linux

References

Module

TraceInsights

Header

/Engine/Source/Developer/TraceInsights/Public/Insights/ViewModels/TimingEventSearch.h

Include

#include "Insights/ViewModels/TimingEventSearch.h"

Syntax

template<typename PayloadType>
struct TTimingEventSearch

Remarks

Helper used to orchestrate a search of a timing event track's events Example of usage: FMyStruct MatchedPayload;

InContext.Check(InEventStartTime, InEventEndTime, 0, Payload);

Functions

Name Description

Public function Static

bool

 

NoFilter

(
    double,
    double,
    uint32,
    const PayloadType&
)

Default predicates.

Public function Static

void

 

NoMatch

(
    double,
    double,
    uint32,
    const PayloadType&
)

Public function Static

bool

 

Search

(
    const FTimingEventSearchParameters ...,
    SearchPredicate InSearchPredicate,
    FoundPredicate InFoundPredicate
)

Search using only the event filter and no match predicate.

Public function Static

bool

 

Search

(
    const FTimingEventSearchParameters ...,
    SearchPredicate InSearchPredicate,
    FoundPredicate InFoundPredicate,
    TTimingEventSearchCache< PayloadTyp...
)

Search using only the event filter, no match predicate and a cache.

Public function Static

bool

 

Search

(
    const FTimingEventSearchParameters ...,
    SearchPredicate InSearchPredicate,
    PayloadFilterPredicate InFilterPred...,
    FoundPredicate InFoundPredicate,
    PayloadMatchedPredicate InPayloadMa...,
    TTimingEventSearchCache< PayloadTyp...
)

Search using a specific payload filter.

Classes

Name

Description

Public struct

FContext

Context used to operate a search.

Typedefs

Name

Description

FoundPredicate

Predicate called when a match has been found.

PayloadFilterPredicate

Predicate called to filter by payload contents Return true to pass the filer

PayloadMatchedPredicate

Predicate called when a match has been made to the search parameters.

SearchPredicate

Predicate called to run the search, e.g. iterate over an array of events It is expected to call FContext::Check on each valid searched event.

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