1. Epic GamesDeveloper
  3. FDataLinkExecutor

FDataLinkExecutor

Executes a Data Link graph with custom instance data.

API > API/Plugins > API/Plugins/DataLink

Executes a Data Link graph with custom instance data.

   
Name FDataLinkExecutor
Type class
Header File /Engine/Plugins/VirtualProduction/DataLink/Source/DataLink/Public/DataLinkExecutor.h
Include Path #include "DataLinkExecutor.h"

Syntax

class FDataLinkExecutor :  
    public FGCObject ,  
    public TSharedFromThis< FDataLinkExecutor >

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FDataLinkExecutor ( FPrivateToken
)

   DataLinkExecutor.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FDataLinkExecutor()

   DataLinkExecutor.h  

Structs

Name Remarks
FPrivateToken  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bPersistExecution bool Whether to keep execution running upon data broadcast, or finish DataLinkExecutor.h  
bRunning bool   DataLinkExecutor.h  
ContextObject TObjectPtr< UObject > Object responsible for this execution DataLinkExecutor.h  
ExecutorId const FGuid Unique Identifier for this Executor DataLinkExecutor.h  
Instance FDataLinkInstance The data link instance of this execution DataLinkExecutor.h  
NodeInstanceMap TMap< TObjectPtr< const UDataLinkNode >, FDataLinkNodeInstance > Map of a Node to its Instance (Input, Output and Instance Data) for this execution DataLinkExecutor.h  
OnExecutionFinished FOnDataLinkExecutionFinished Delegate to call when the data link execution finishes DataLinkExecutor.h  
OnOutputData FOnDataLinkOutputData Delegate to call when the data link outputs data DataLinkExecutor.h  
OutputProcessors TArray< TObjectPtr< UDataLinkProcessor > > Container for all the output processors in this execution DataLinkExecutor.h  
Sink TSharedPtr< FDataLinkSink > Sink where all the data for this execution is queried and stored DataLinkExecutor.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Fail ( const UDataLinkNode* InNode
)

 Called when a node has failed to receive data and produce a valid output This stops the entire graph execution DataLinkExecutor.h  

FDataLinkNodeInstance * FindNodeInstanceMutable ( const UDataLinkNode* InNode
)

 Finds the node instance data (mutable) of this execution for the given node, or null if already removed DataLinkExecutor.h  

FStringView GetContextName ()

 Gets a brief description of the context for debugging purposes. DataLinkExecutor.h  

UObject * GetContextObject()

 Gets the object that is responsible for this execution DataLinkExecutor.h  

const FGuid & GetExecutorId()

 Gets the unique identifier for this Executor DataLinkExecutor.h  

const FDataLinkNodeInstance & GetNodeInstance ( const UDataLinkNode* InNode
) const

 Retrieves the node instance data of this execution for the given node DataLinkExecutor.h  

FDataLinkNodeInstance & GetNodeInstanceMutable ( const UDataLinkNode* InNode
)

 Retrieves the node instance data (mutable) of this execution for the given node DataLinkExecutor.h  

bool IsRunning()

   DataLinkExecutor.h  

void Next ( const UDataLinkNode* InNode
)

 Called when a node has received data successfully and is ready to pass it to the next node If this is called from the output node, it will broadcast this data to the listeners instead DataLinkExecutor.h  

void NextPersist ( const UDataLinkNode* InNode
)

 Used by Nodes that keep receiving data (instead of being a one-off) to keep execution active. DataLinkExecutor.h  

void Run()

 Called to start the graph execution DataLinkExecutor.h  

void Stop ( EDataLinkExecutionResult InExecutionResult
)

 Called to stop graph execution DataLinkExecutor.h  

Static

Name Remarks Include Path Unreal Specifiers
  DataLinkExecutor.h  

See Also

  • FDataLinkExecutor::Run

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page