1. Epic GamesDeveloper
  3. UDataprepAsset

UDataprepAsset

A DataprepAsset is an implementation of the DataprepAssetInterface using a Blueprint as the recipe pipeline.

API > API/Plugins > API/Plugins/DataprepCore

A DataprepAsset is an implementation of the DataprepAssetInterface using a Blueprint as the recipe pipeline. The Blueprint is composed of DataprepAction nodes linearly connected.

   
Name UDataprepAsset
Type class
Header File /Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/Public/DataprepAsset.h
Include Path #include "DataprepAsset.h"

Syntax

UCLASS (BlueprintType)  
class UDataprepAsset : public UDataprepAssetInterface

Inheritance Hierarchy

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~UDataprepAsset()

   DataprepAsset.h  

Classes

Name Remarks
FDataprepParameterizationStatusForObjectsChanged Event to notify the ui that a Dataprep parametrization was modified This necessary as the ui for the parameterization is only updated by manual event (the ui don't pull new values each frame) Note on the objects param: The parameterized objects that should refresh their ui.
FOnDataprepActionAssetChange Allow an observer to be notified of an change in the pipeline return The event that will be broadcasted when a object has receive a modification that might change the result of the pipeline
FOnStepObjectsAboutToBeRemoved Allow an observer to be notified of the removal of some step from the asset

Structs

Name Remarks
FRestrictedToActionAsset  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
GetOnStepObjectsAboutToBeRemoved UDataprepAsset::FRestrictedToActionAsset &   DataprepAsset.h  
OnParameterizedObjectsStatusChanged UDataprepAsset::FDataprepParameterizationStatusForObjectsChanged   DataprepAsset.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
ActionAssets TArray< TObjectPtr< UDataprepActionAsset > >   DataprepAsset.h  
AppearanceSignatureBeforeUndoRedo FString   DataprepAsset.h  
OnActionChanged FOnDataprepActionAssetChange   DataprepAsset.h  
OnStepObjectsAboutToBeRemoved FOnStepObjectsAboutToBeRemoved   DataprepAsset.h  
Parameterization TObjectPtr< UDataprepParameterization >   DataprepAsset.h  
SignatureBeforeUndoRedo FString Used on undo/redo to detect addition/removal compared to change in execution order of actions DataprepAsset.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

int32 AddAction ( const TArray< const UDataprepActionStep* >& ActionSteps
)

 Creates an action from the array of action steps or one action per action steps then add the action(s) to the Dataprep asset DataprepAsset.h  

int32 AddAction ( const UDataprepActionAsset* Action
)

 Add a copy of the action to the Dataprep asset DataprepAsset.h  

int32 AddActions ( const TArray< const UDataprepActionAsset* >& Actions
)

 Add the actions to the Dataprep asset DataprepAsset.h  

void BindObjectPropertyToParameterization ( UDataprepParameterizableObject* Object,
const TArray< struct FDataprepPropertyLink >& InPropertyChain,
const FName& Name
)

   DataprepAsset.h  

bool CreateParameterization()

   DataprepAsset.h  

UDataprepActionAsset * GetAction ( int32 Index
)

   DataprepAsset.h  

const UDataprepActionAsset * GetAction ( int32 Index
) const

   DataprepAsset.h  

int32 GetActionCount()

   DataprepAsset.h  

int32 GetActionIndex ( UDataprepActionAsset* ActionAsset
) const

   DataprepAsset.h  

UDataprepParameterization * GetDataprepParameterization()

 Internal only for now. DataprepAsset.h  

void GetExistingParameterNamesForType ( FProperty* Property,
bool bIsDescribingFullProperty,
TSet< FString >& OutValidExistingNames,
TSet< FString >& OutInvalidNames
) const

   DataprepAsset.h  

FName GetNameOfParameterForObjectProperty ( UDataprepParameterizableObject* Object,
const TArray< struct FDataprepPropertyLink >& InPropertyChain
) const

   DataprepAsset.h  

UDataprepAsset::FOnDataprepActionAssetChange TBaseMulticastDelegate_TwoParams GetOnActionChanged()

   DataprepAsset.h  

UDataprepAsset::FOnStepObjectsAboutToBeRemoved TBaseMulticastDelegate_OneParam GetOnStepObjectsAboutToBeRemoved()

   DataprepAsset.h  

bool InsertAction ( int32 Index
)

 Creates a new action then insert the action to the Dataprep asset at the requested index DataprepAsset.h  

bool InsertAction ( const UDataprepActionAsset* InAction,
int32 Index
)

 Insert a copy of the action to the Dataprep asset at the requested index DataprepAsset.h  

bool InsertAction ( const TArray< const UDataprepActionStep* >& InActionSteps,
int32 Index
)

 Creates an action from the array of action steps or one action per action steps then insert the action(s) to the Dataprep asset at the requested index DataprepAsset.h  

bool InsertActions ( const TArray< const UDataprepActionAsset* >& InActions,
int32 Index
)

 Insert a copy of each action into the Dataprep asset at the requested index DataprepAsset.h  

bool IsObjectPropertyBinded ( UDataprepParameterizableObject* Object,
const TArray< struct FDataprepPropertyLink >& InPropertyChain
) const

   DataprepAsset.h  

bool MoveAction ( int32 SourceIndex,
int32 DestinationIndex
)

 Move an action to another spot in the order of actions This operation take O(n) time. DataprepAsset.h  

bool MoveActions ( int32 FirstIndex,
int32 Count,
int32 MovePositions
)

 Move group of actions to another spot in the order of actions DataprepAsset.h  

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   DataprepAsset.h  

virtual void PostEditUndo()

   DataprepAsset.h  

virtual void PreEditUndo()

   DataprepAsset.h  

bool RemoveAction ( int32 Index,
bool bDiscardParametrization
)

 Remove an action from the Dataprep asset DataprepAsset.h  

bool RemoveActions ( const TArray< int32 >& Indices,
bool bDiscardParametrization
)

 Remove a set of actions from the Dataprep asset DataprepAsset.h  

void RemoveObjectPropertyFromParameterization ( UDataprepParameterizableObject* Object,
const TArray< struct FDataprepPropertyLink >& InPropertyChain
)

   DataprepAsset.h  

virtual bool Rename ( const TCHAR* NewName,
UObject* NewOuter,
ERenameFlags Flags
)

   DataprepAsset.h  

bool SwapActions ( int32 FirstActionIndex,
int32 SecondActionIndex
)

 Swap the actions of a Dataprep asset DataprepAsset.h  

Overridden from UDataprepAssetInterface

Name Remarks Include Path Unreal Specifiers

virtual void ExecuteRecipe ( const TSharedPtr< FDataprepActionContext >& InActionsContext
)

 Sequentially execute all the actions held by the Dataprep asset DataprepAsset.h  

virtual const TArray< UDataprepActionAsset * > & GetActions()

   DataprepAsset.h  

virtual UObject * GetParameterizationObject()

 Internal Use only (the current implementation might be subject to change) DataprepAsset.h  

virtual bool HasActions()

   DataprepAsset.h  

virtual void PostLoad()

   DataprepAsset.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
Consumer_DEPRECATED TObjectPtr< UDataprepContentConsumer > DEPRECATED: COnsumer referenced by the asset DataprepAsset.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property moved to UDataprepAssetInterface as Output.")
DataprepRecipeBP_DEPRECATED TObjectPtr< UBlueprint > DEPRECATED: Pointer to data preparation pipeline blueprint previously used to process input data DataprepAsset.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Using directly ActionAssets property instead of Blueprint to manage actions.")
Producers_DEPRECATED TArray< FDataprepAssetProducer > DEPRECATED: List of producers referenced by the asset DataprepAsset.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Property moved to UDataprepAssetInterface as Inputs.")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page