Navigation
API > API/Plugins > API/Plugins/DataLink
Executes a Data Link graph with custom instance data.
| Name | FDataLinkExecutor |
| Type | class |
| Header File | /Engine/Plugins/Experimental/DataLink/Source/DataLink/Public/DataLinkExecutor.h |
| Include Path | #include "DataLinkExecutor.h" |
Syntax
class FDataLinkExecutor :
public FGCObject ,
public TSharedFromThis< FDataLinkExecutor >
Inheritance Hierarchy
- FGCObject → FDataLinkExecutor
- FSharedFromThisBase → TSharedFromThis → FDataLinkExecutor
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDataLinkExecutor
(
FPrivateToken |
DataLinkExecutor.h |
Structs
| Name | Remarks |
|---|---|
| FPrivateToken |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| 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 | |
| OnFinishDelegate | FOnDataLinkExecutionFinished | Delegate to call when the execution completes | 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 FailNode
(
const UDataLinkNode* InNode |
Called when a node has failed to execute 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 |
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 | |
void Run() |
Called to start the graph execution | DataLinkExecutor.h | |
void SucceedNode
(
const UDataLinkNode* InNode, |
Called when a node has finished executing successfully If it's the output node that has finished executing, it will finish the entire graph execution | DataLinkExecutor.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static TSharedPtr< FDataLinkExecutor > Create
(
FDataLinkExecutorArguments&& InArgs |
DataLinkExecutor.h |
See Also
- FDataLinkExecutor::Run