UDataprepAsset

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

DataprepCore

Header

/Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/Public/DataprepAsset.h

Include

#include "DataprepAsset.h"

Syntax

UCLASS (Experimental, BlueprintType)
class UDataprepAsset : public UDataprepAssetInterface

Remarks

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

Variables

Destructors

Name Description

Public function Virtual

~UDataprepAsset()

Functions

Name Description

Public function

int32

 

AddAction

(
    const TArray < const UDataprepAction ...
)

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

Public function

int32

 

AddAction

(
    const UDataprepActionAsset * Ac...
)

Add a copy of the action to the Dataprep asset

Public function

int32

 

AddActions

(
    const TArray < const UDataprepAction ...
)

Add the actions to the Dataprep asset

Public function

void

 

BindObjectPropertyToParameterization

(
    UDataprepParameterizableObject *...,
    const TArray < struct FDataprepPrope ...,
    const FName & Name
)

Public function

bool

 

CreateParameterization()

Public function

UDataprepAct ...

 

GetAction

(
    int32 Index
)

Public function Const

const UDatap ...

 

GetAction

(
    int32 Index
)

Public function Const

int32

 

GetActionCount()

Public function Const

int32

 

GetActionIndex

(
    UDataprepActionAsset * ActionAs...
)

Public function

UDataprepPar...

 

GetDataprepParameterization()

Internal only for now.

Public function Const

void

 

GetExistingParameterNamesForType

(
    FProperty * Property,
    bool bIsDescribingFullProperty,
    TSet < FString >& OutValidExistingN...,
    TSet < FString >& OutInvalidNames
)

Public function Const

FName

 

GetNameOfParameterForObjectProperty

(
    UDataprepParameterizableObject *...,
    const TArray < struct FDataprepPrope ...
)

Public function

UDataprepAss ...

 

GetOnActionChanged()

Public function

UDataprepAss ...

 

GetOnStepObjectsAboutToBeRemoved()

Public function

bool

 

InsertAction

(
    int32 Index
)

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

Public function

bool

 

InsertAction

(
    const UDataprepActionAsset * In...,
    int32 Index
)

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

Public function

bool

 

InsertAction

(
    const TArray < const UDataprepAction ...,
    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

Public function

bool

 

InsertActions

(
    const TArray < const UDataprepAction ...,
    int32 Index
)

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

Public function Const

bool

 

IsObjectPropertyBinded

(
    UDataprepParameterizableObject *...,
    const TArray < struct FDataprepPrope ...
)

Public function

bool

 

MoveAction

(
    int32 SourceIndex,
    int32 DestinationIndex
)

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

Public function

bool

 

RemoveAction

(
    int32 Index
)

Remove an action from the Dataprep asset

Public function

bool

 

RemoveActions

(
    const TArray < int32 >& Indices
)

Remove a set of actions from the Dataprep asset

Public function

void

 

RemoveObjectPropertyFromParameterization

(
    UDataprepParameterizableObject *...,
    const TArray < struct FDataprepPrope ...
)

Public function

bool

 

SwapActions

(
    int32 FirstActionIndex,
    int32 SecondActionIndex
)

Swap the actions of a Dataprep asset

Overridden from UDataprepAssetInterface

Name Description

Public function Virtual

void

 

ExecuteRecipe

(
    const TSharedPtr < FDataprepActionCo ...
)

Sequentially execute all the actions held by the Dataprep asset

Public function Virtual Const

const TArray ...

 

GetActions()

Public function Virtual

UObject *...

 

GetParameterizationObject()

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

Public function Virtual Const

bool

 

HasActions()

Overridden from UObject

Name Description

Public function Virtual

void

 

PostDuplicate

(
    EDuplicateMode::Type DuplicateMode
)

Public function Virtual

void

 

PostEditUndo()

Called after applying a transaction to the object.

Public function Virtual

void

 

PostLoad()

Do any object-specific cleanup required immediately after loading an object.

Public function Virtual

void

 

PreEditUndo()

Called before applying a transaction to the object.

Public function Virtual

bool

 

Rename

(
    const TCHAR * NewName,
    UObject * NewOuter,
    ERenameFlags Flags
)

Rename this object to a unique name, or change its outer.

Classes

Name

Description

Public class

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.

Public class

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

Public class

FOnStepObjectsAboutToBeRemoved

Allow an observer to be notified of the removal of some step from the asset

Public struct

FRestrictedToActionAsset

Deprecated Variables

Name Description

Protected variable UProperty Meta

UDataprepConten ...

 

Consumer_DEPRECATED

DEPRECATED: COnsumer referenced by the asset

Protected variable UProperty Meta

UBlueprint *...

 

DataprepRecipeBP_DEPRECATED

DEPRECATED: Pointer to data preparation pipeline blueprint previously used to process input data

Protected variable UProperty Meta

TArray < FDatapr ...

 

Producers_DEPRECATED

DEPRECATED: List of producers referenced by the asset

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback