TTimingEventSearch

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

Unreal Engine C++ API Reference > Developer > TraceInsights > Insights > ViewModels

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;

TTimingEventSearch::Search( Parameters, { for (FMyStruct& Payload : Payloads) { InContext.Check(InEventStartTime, InEventEndTime, 0, Payload); } }, &MatchedPayload { MatchedPayload = InEvent; }, &MatchedPayload { // Do something with MatchedPayload, e.g. call a captured lambda. });

Functions

Type Name Description
bool NoFilter ( double, double, uint32, const PayloadType& ) Default predicates.
void NoMatch ( double, double, uint32, const PayloadType& )  
bool Search ( const FTimingEventSearchParameters ..., SearchPredicate InSearchPredicate, FoundPredicate InFoundPredicate ) Search using only the event filter and no match predicate.
bool Search ( const FTimingEventSearchParameters ..., SearchPredicate InSearchPredicate, FoundPredicate InFoundPredicate, TTimingEventSearchCache< PayloadTyp... ) Search using only the event filter, no match predicate and a cache.
bool Search ( const FTimingEventSearchParameters ..., SearchPredicate InSearchPredicate, PayloadFilterPredicate InFilterPred..., FoundPredicate InFoundPredicate, PayloadMatchedPredicate InPayloadMa..., TTimingEventSearchCache< PayloadTyp... ) Search using a specific payload filter.

Classes

Type 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.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library