Navigation
API > API/Runtime > API/Runtime/DataflowCore
| Name | FDataflowOutput |
| Type | struct |
| Header File | /Engine/Source/Runtime/Experimental/Dataflow/Core/Public/Dataflow/DataflowInputOutput.h |
| Include Path | #include "Dataflow/DataflowInputOutput.h" |
Syntax
USTRUCT ()
struct FDataflowOutput : public FDataflowConnection
Inheritance Hierarchy
- FDataflowConnection → FDataflowOutput
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDataflowOutput
(
const UE::Dataflow::FOutputParameters& Param |
Dataflow/DataflowInputOutput.h | ||
FDataflowOutput
(
const FDataflowOutput& |
Dataflow/DataflowInputOutput.h | ||
FDataflowOutput
(
const UE::Dataflow::FOutputParameters& Param, |
Dataflow/DataflowInputOutput.h | ||
| Dataflow/DataflowInputOutput.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FDataflowOutput() |
Dataflow/DataflowInputOutput.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| NoOpOutput | FDataflowOutput | Dataflow/DataflowInputOutput.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Connections | TArray< FDataflowInput * > | Dataflow/DataflowInputOutput.h | ||
| OutputLock | TSharedPtr< FCriticalSection > | Dataflow/DataflowInputOutput.h | ||
| PassthroughKey | UE::Dataflow::FConnectionKey | Dataflow/DataflowInputOutput.h | ||
| PassthroughOffset | uint32 | Dataflow/DataflowInputOutput.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool Evaluate
(
UE::Dataflow::FContext& Context |
Dataflow/DataflowInputOutput.h | ||
bool EvaluateImpl
(
UE::Dataflow::FContext& Context |
Dataflow/DataflowInputOutput.h | ||
TFuture< bool > EvaluateParallel
(
UE::Dataflow::FContext& Context |
Dataflow/DataflowInputOutput.h | ||
void ForwardInput
(
const FDataflowInput* Input, |
Dataflow/DataflowInputOutput.h | ||
void ForwardInput
(
const UE::Dataflow::FConnectionReference& InputReference, |
There's no need for a templatized version as the parameter will not be used the method do check if the type of the input is the same as the output type though | Dataflow/DataflowInputOutput.h | |
void Freeze
(
UE::Dataflow::FContext& Context, |
Freeze the value of this output to the node property bag. | Dataflow/DataflowInputOutput.h | |
virtual TArray< FDataflowInput * > GetConnectedInputs () |
Dataflow/DataflowInputOutput.h | ||
virtual const TArray< const FDataflowInput * > GetConnectedInputs () |
Dataflow/DataflowInputOutput.h | ||
TArray< FDataflowInput * > & GetConnections () |
Dataflow/DataflowInputOutput.h | ||
const TArray< FDataflowInput * > & GetConnections () |
Dataflow/DataflowInputOutput.h | ||
const T & GetFrozenValue
(
const T& Default |
Return a pointer to the node's output storage if it has been successfully evaluated and frozen, or the provided default value otherwise. | Dataflow/DataflowInputOutput.h | |
const FDataflowInput * GetPassthroughInput() |
Dataflow/DataflowInputOutput.h | ||
virtual void * GetPassthroughRealAddress() |
Dataflow/DataflowInputOutput.h | ||
const T & GetValue
(
UE::Dataflow::FContext& Context, |
Get most updated value of the output if the value is cache or frozen return it otherwise evaluates the node with potentially cascading evaluation of the graph | Dataflow/DataflowInputOutput.h | |
bool HasAnyConnections() |
Dataflow/DataflowInputOutput.h | ||
bool HasCachedValue
(
const UE::Dataflow::FContext& Context |
Dataflow/DataflowInputOutput.h | ||
bool HasFrozenValue() |
Return whether the output has a frozen value in its owner node. | Dataflow/DataflowInputOutput.h | |
bool HasNodeFailedOrErrored
(
UE::Dataflow::FContext& Context |
Check if OwningNode has an error or it has failed, and if it does set the timestamp on the output(s) to FTimestamp::Invalid. | Dataflow/DataflowInputOutput.h | |
bool HasValidData
(
UE::Dataflow::FContext& Context |
Dataflow/DataflowInputOutput.h | ||
const T & ReadValue
(
UE::Dataflow::FContext& Context, |
Read value returns the cache value on the output without causing an evaluation of the corresponding node as a result it does not cause a cascading evaluation of the graph if there's no cached value this will return the default value passed as a parameter | Dataflow/DataflowInputOutput.h | |
TAnyType::FStorageType ReadValue
(
UE::Dataflow::FContext& Context, |
Dataflow/DataflowInputOutput.h | ||
void SetNullValue
(
UE::Dataflow::FContext& Context |
Set a null value : this means that the connected input will get a default value and that this output will not be set re-evaluate next time | Dataflow/DataflowInputOutput.h | |
FDataflowOutput & SetPassthroughInput
(
const UE::Dataflow::FConnectionKey& Key |
Dataflow/DataflowInputOutput.h | ||
FDataflowOutput & SetPassthroughInput
(
const UE::Dataflow::FConnectionReference& Reference |
Dataflow/DataflowInputOutput.h | ||
virtual void SetPassthroughOffset
(
const uint32 InPassthroughOffset |
Dataflow/DataflowInputOutput.h | ||
void SetValue
(
T&& InVal, |
Dataflow/DataflowInputOutput.h | ||
void SetValueFromAnyType
(
const typename TAnyType::FStorageType& InVal, |
Dataflow/DataflowInputOutput.h | ||
void SetValueFromStructArrayView
(
const FConstStructArrayView& StructArrayView, |
Dataflow/DataflowInputOutput.h | ||
void SetValueFromStructView
(
const FConstStructView& StructView, |
Dataflow/DataflowInputOutput.h |
Overridden from FDataflowConnection
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool AddConnection
(
FDataflowConnection* InOutput |
Dataflow/DataflowInputOutput.h | ||
virtual void GetConnections
(
TArray< FDataflowConnection* >& OutConnections |
Dataflow/DataflowInputOutput.h | ||
virtual void Invalidate
(
const UE::Dataflow::FTimestamp& ModifiedTimestamp |
Dataflow/DataflowInputOutput.h | ||
virtual bool IsConnected() |
Dataflow/DataflowInputOutput.h | ||
virtual bool RemoveConnection
(
FDataflowConnection* InInput |
Dataflow/DataflowInputOutput.h |
Protected
Overridden from FDataflowConnection
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void FixAndPropagateType
(
FName InType |
Dataflow/DataflowInputOutput.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FDataflowOutput & operator=
(
FDataflowOutput&& |
Dataflow/DataflowInputOutput.h | ||
FDataflowOutput & operator=
(
const FDataflowOutput& |
Dataflow/DataflowInputOutput.h |