IDefinitionProvider

Allows users to publish "definitions", structs representing a definition event.

Unreal Engine C++ API Reference > Developer > TraceServices > TraceServices > Model

Inheritance Hierarchy

References

   
Module TraceServices
Header /Engine/Source/Developer/TraceServices/Public/TraceServices/Model/Definitions.h
Include #include "TraceServices/Model/Definitions.h"

Syntax

class IDefinitionProvider :  
    public [TraceServices::IProvider](API\Developer\TraceServices\TraceServices\Model\IProvider),  
    public [TraceServices::IEditableProvider](API\Developer\TraceServices\TraceServices\Model\IEditableProvider)  

Remarks

Allows users to publish "definitions", structs representing a definition event. This data can then be queried when resolving a reference field in another event.

If your definition type reference other definitions it is encouraged to resolve those during analysis to avoid having to resolve complex chains on every lookup. Example usage: This code creates a definition, initializes the instance, resolves a reference and finally registers it. FMyDefinitionClass*Instance=DefinitionProvider->Create();Instance->SomeValue=EventData.GetValue("SomeValue");constFEventRefReference=EventData.GetReferenceValue("SomeString");Instance->SomeString=DefinitionProvider->Get(Reference)->Display;...constUE::Trace::FEventRefId(EventData.GetDefinitionId(),EventData.GetTypeInfo().GetId());DefinitionProvider->Register(Instance,Id);

Variables

Type Name Description
TMap< uint32, S... Stringifiers  

Destructors

Type Name Description
  ~IDefinitionProvider ()  

Functions

Type Name Description
void AddEntry ( uint64 Hash, const void* Ptr )  
void * Allocate ( uint32 Size, uint32 Alignment )  
T * Create () Allocates memory for the definition.
const void &... FindEntry ( uint64 Hash )  
const T *... Get ( const UE::Trace::TEventRef< Definit... ) Attempts to retrieve a previously registered instance of a definition using a reference.
FString GetAsString ( const UE::Trace::TEventRef< Definit... ) Gets the definition as a owned string.
void Register ( const T* Instance, const UE::Trace::TEventRef< Definit... ) Makes the instance of a definition visible to queries.

Typedefs

Name Description
StringifierFn  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library