1. Epic GamesDeveloper
  3. FContext

FContext

Dataflow context base class

API > API/Runtime > API/Runtime/DataflowCore

Dataflow context base class

   
Name FContext
Type class
Header File /Engine/Source/Runtime/Experimental/Dataflow/Core/Public/Dataflow/DataflowNodeParameters.h
Include Path #include "Dataflow/DataflowNodeParameters.h"

Syntax

class FContext :  
    public UE::Dataflow::IContextCacheStore ,  
    public UE::Dataflow::IContextAssetStoreInterface

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers
  Dataflow/DataflowNodeParameters.h  

FContext ( const FContext&
)

   Dataflow/DataflowNodeParameters.h  
  Dataflow/DataflowNodeParameters.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FContext()

   Dataflow/DataflowNodeParameters.h  

Typedefs

Name Type Remarks Include Path
FOnContextHasErrorMulticast TMulticastDelegate_ThreeParams< void, const FDataflowNode *Node, const FDataflowOutput *Output, const FString &Info >   Dataflow/DataflowNodeParameters.h
FOnContextHasInfoMulticast TMulticastDelegate_ThreeParams< void, const FDataflowNode *Node, const FDataflowOutput *Output, const FString &Info >   Dataflow/DataflowNodeParameters.h
FOnContextHasWarningMulticast TMulticastDelegate_ThreeParams< void, const FDataflowNode *Node, const FDataflowOutput *Output, const FString &Info >   Dataflow/DataflowNodeParameters.h
FOnNodeBeginEvaluateMulticast TMulticastDelegate_TwoParams< void, const FDataflowNode *Node, const FDataflowOutput *Output >   Dataflow/DataflowNodeParameters.h
FOnNodeFinishEvaluateMulticast TMulticastDelegate_TwoParams< void, const FDataflowNode *Node, const FDataflowOutput *Output >   Dataflow/DataflowNodeParameters.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnContextHasError FOnContextHasErrorMulticast   Dataflow/DataflowNodeParameters.h  
OnContextHasInfo FOnContextHasInfoMulticast   Dataflow/DataflowNodeParameters.h  
OnContextHasWarning FOnContextHasWarningMulticast   Dataflow/DataflowNodeParameters.h  
OnNodeBeginEvaluateMulticast FOnNodeBeginEvaluateMulticast   Dataflow/DataflowNodeParameters.h  
OnNodeFinishEvaluateMulticast FOnNodeFinishEvaluateMulticast   Dataflow/DataflowNodeParameters.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
AssetStore FContextAssetStore Used to store the dependent asset created during the evaluation of the graph Dataflow/DataflowNodeParameters.h  
Callstack FContextCallstack   Dataflow/DataflowNodeParameters.h  
NodesFailed TSet< const FDataflowNode * >   Dataflow/DataflowNodeParameters.h  
NodesWithError TSet< const FDataflowNode * >   Dataflow/DataflowNodeParameters.h  
NodesWithInfo TSet< const FDataflowNode * >   Dataflow/DataflowNodeParameters.h  
NodesWithWarning TSet< const FDataflowNode * >   Dataflow/DataflowNodeParameters.h  
PerfData FContextPerfData   Dataflow/DataflowNodeParameters.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

T * AsType ()

   Dataflow/DataflowNodeParameters.h  

const T * AsType ()

   Dataflow/DataflowNodeParameters.h  

void CancelAsyncEvaluation()

   Dataflow/DataflowNodeParameters.h  

void ClearAllData()

   Dataflow/DataflowNodeParameters.h  

void ClearNodeData ( const FDataflowNode* InNode
)

   Dataflow/DataflowNodeParameters.h  

void ClearNodesData()

   Dataflow/DataflowNodeParameters.h  

bool CopyDataToAnotherContext ( const FContextCacheKey InSourceKey,
FContext& TargetContext,
const FContextCacheKey InTargetKey,
const FProperty* InProperty,
const FGuid& InNodeGuid,
uint32 InNodeHash,
const FTimestamp& InTimestamp
) const

   Dataflow/DataflowNodeParameters.h  

void EnablePerfData ( bool bEnable
)

   Dataflow/DataflowNodeParameters.h  

void Error ( const FString& InError,
const FDataflowNode* InNode,
const FDataflowOutput* InOutput
)

   Dataflow/DataflowNodeParameters.h  

void Evaluate ( const FDataflowNode* Node,
const FDataflowOutput* Output,
FOnPostEvaluationFunction PostEvaluationFunction
)

   Dataflow/DataflowNodeParameters.h  

virtual void Evaluate ( const FDataflowNode* Node,
const FDataflowOutput* Output
)

   Dataflow/DataflowNodeParameters.h  

virtual bool Evaluate ( const FDataflowOutput& Connection
)

   Dataflow/DataflowNodeParameters.h  

int32 GetArraySizeFromData ( const FContextCacheKey InKey
) const

   Dataflow/DataflowNodeParameters.h  

void GetAsyncEvaluationStats ( int32& OutNumPendingTasks,
int32& OutNumRunningTasks,
int32& OutNumCompletedTasks
) const

   Dataflow/DataflowNodeParameters.h  

const T & GetData ( FContextCacheKey Key,
const FProperty* InProperty,
const T& Default
) const

   Dataflow/DataflowNodeParameters.h  

virtual const TUniquePtr< FContextCacheElementBase > * GetDataImpl ( FContextCacheKey Key
) const

   Dataflow/DataflowNodeParameters.h  

virtual int32 GetKeys ( TSet< FContextCacheKey >& InKeys
) const

   Dataflow/DataflowNodeParameters.h  

int32 GetNumErrors()

   Dataflow/DataflowNodeParameters.h  

int32 GetNumInfo()

   Dataflow/DataflowNodeParameters.h  

int32 GetNumWarnings()

   Dataflow/DataflowNodeParameters.h  

FContextPerfData::FData GetPerfDataForNode ( const FDataflowNode& Node
) const

   Dataflow/DataflowNodeParameters.h  

FTimestamp GetTimestamp ( FContextCacheKey Key
) const

   Dataflow/DataflowNodeParameters.h  

virtual FName GetType()

   Dataflow/DataflowNodeParameters.h  

const void * GetUntypedData ( FContextCacheKey Key,
const FProperty* InProperty
) const

   Dataflow/DataflowNodeParameters.h  

bool HasData ( FContextCacheKey Key,
FTimestamp InTimestamp
) const

   Dataflow/DataflowNodeParameters.h  

virtual bool HasDataImpl ( FContextCacheKey Key,
FTimestamp InTimestamp
) const

   Dataflow/DataflowNodeParameters.h  

void Info ( const FString& InInfo,
const FDataflowNode* InNode,
const FDataflowOutput* InOutput
)

   Dataflow/DataflowNodeParameters.h  

virtual bool IsA ( FName InType
) const

   Dataflow/DataflowNodeParameters.h  

bool IsAsyncEvaluating()

   Dataflow/DataflowNodeParameters.h  

bool IsCacheEntryAfterTimestamp ( FContextCacheKey InKey,
const FTimestamp InTimestamp
) const

   Dataflow/DataflowNodeParameters.h  

bool IsEmpty()

   Dataflow/DataflowNodeParameters.h  

virtual bool IsEmptyImpl()

   Dataflow/DataflowNodeParameters.h  

bool IsInCallstack ( const FDataflowConnection* Connection
) const

   Dataflow/DataflowNodeParameters.h  

bool IsPerfDataEnabled()

   Dataflow/DataflowNodeParameters.h  

bool IsThreaded()

   Dataflow/DataflowNodeParameters.h  

bool NodeFailed ( const FDataflowNode* InNode
)

   Dataflow/DataflowNodeParameters.h  

bool NodeHasError ( const FDataflowNode* InNode
)

   Dataflow/DataflowNodeParameters.h  

bool NodeHasWarning ( const FDataflowNode* InNode
)

   Dataflow/DataflowNodeParameters.h  

void PopFromCallstack ( const FDataflowConnection* Connection
)

   Dataflow/DataflowNodeParameters.h  

void PushToCallstack ( const FDataflowConnection* Connection
)

   Dataflow/DataflowNodeParameters.h  

void ResetPerfDataForNode ( const FDataflowNode& Node
)

   Dataflow/DataflowNodeParameters.h  

virtual void Serialize ( FArchive& Ar
)

   Dataflow/DataflowNodeParameters.h  

void SetArrayElementFromData ( const FContextCacheKey InArrayKey,
int32 Index,
const FContextCacheKey InElementKey,
const FProperty* InProperty,
const FGuid& InNodeGuid,
uint32 InNodeHash,
const FTimestamp& InTimestamp
)

   Dataflow/DataflowNodeParameters.h  

void SetData ( FContextCacheKey InKey,
const FProperty* InProperty,
T&& InValue,
const FGuid& InNodeGuid,
uint32 InNodeHash,
const FTimestamp& InTimestamp
)

   Dataflow/DataflowNodeParameters.h  

void SetDataFromStructArrayView ( FContextCacheKey InKey,
const FProperty* InProperty,
const FConstStructArrayView& StructArrayView,
const FGuid& InNodeGuid,
uint32 InNodeHash,
const FTimestamp& InTimestamp
)

   Dataflow/DataflowNodeParameters.h  

void SetDataFromStructView ( FContextCacheKey InKey,
const FProperty* InProperty,
const FConstStructView& StructView,
const FGuid& InNodeGuid,
uint32 InNodeHash,
const FTimestamp& InTimestamp
)

   Dataflow/DataflowNodeParameters.h  

virtual void SetDataImpl ( FContextCacheKey Key,
TUniquePtr< FContextCacheElementBase >&& DataStoreEntry
)

   Dataflow/DataflowNodeParameters.h  

void SetDataReference ( FContextCacheKey Key,
const FProperty* Property,
FContextCacheKey ReferenceKey,
const FTimestamp& InTimestamp
)

   Dataflow/DataflowNodeParameters.h  

void SetNullData ( FContextCacheKey InKey,
const FProperty* InProperty,
const FGuid& InNodeGuid,
uint32 InNodeHash,
const FTimestamp& InTimestamp
)

 This is useful when there's a need to have to have cache entry but the type is not known and there no connected output ( like reroute nodes with unconnected input for example ) in that case posting an invalid reference, will allow the evaluatino to go through and the node reading it will get a default value instead Dataflow/DataflowNodeParameters.h  

void SetThreaded ( bool bValue
)

   Dataflow/DataflowNodeParameters.h  

void Warning ( const FString& InWarning,
const FDataflowNode* InNode,
const FDataflowOutput* InOutput
)

   Dataflow/DataflowNodeParameters.h  

Overridden from IContextCacheStore

Name Remarks Include Path Unreal Specifiers

virtual const TUniquePtr< FContextCacheElementBase > * FindCacheElement ( FContextCacheKey InKey
) const

 Begin - IContextCacheStore. Dataflow/DataflowNodeParameters.h  

virtual bool HasCacheElement ( FContextCacheKey InKey,
FTimestamp InTimestamp
) const

   Dataflow/DataflowNodeParameters.h  

Overridden from IContextAssetStoreInterface

Name Remarks Include Path Unreal Specifiers

virtual UObject * AddAsset ( const FString& PersistentAssetPath,
const UClass* AssetClass
)

 Create an new asset to be commited later ( when the terminal nodes are evaluated ) When commited, the asset will be duplicated to a final package matching PersistentAssetPath Dataflow/DataflowNodeParameters.h  

virtual void ClearAssets()

 Clear all assets from the store Dataflow/DataflowNodeParameters.h  

virtual UObject * CommitAsset ( const FString& TransientAssetPath
)

 Commit the asset matching the TransientAssetPath If such asset was added previously this will duplicate it and save it to a persistent package Dataflow/DataflowNodeParameters.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BeginContextEvaluation ( const FDataflowNode* Node,
const FDataflowOutput* Output
)

   Dataflow/DataflowNodeParameters.h  

Static

Name Remarks Include Path Unreal Specifiers

static FName StaticType()

   Dataflow/DataflowNodeParameters.h  

Operators

Name Remarks Include Path Unreal Specifiers

FContext & operator= ( const FContext&
)

   Dataflow/DataflowNodeParameters.h  
  Dataflow/DataflowNodeParameters.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page