TTimingEventSearch | Unreal Engine 4.27 Documentation

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& InParameters, SearchPredicate InSearchPredicate, FoundPredicate InFoundPredicate )	Search using only the event filter and no match predicate.
bool	Search ( const FTimingEventSearchParameters& InParameters, SearchPredicate InSearchPredicate, FoundPredicate InFoundPredicate, TTimingEventSearchCache< PayloadType >& InCache )	Search using only the event filter, no match predicate and a cache.
bool	Search ( const FTimingEventSearchParameters& InParameters, SearchPredicate InSearchPredicate, PayloadFilterPredicate InFilterPredicate, FoundPredicate InFoundPredicate, PayloadMatchedPredicate InPayloadMatchedPredicate, TTimingEventSearchCache< PayloadType >* InCache )	Search using a specific payload filter.

Classes

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