UEditorDataprepAssetLibrary

Utility class to do most expose most of the common functionalities of the dataprep editor plugin (Visual Dataprep).

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

DataprepEditorScriptingUtilities

Header

/Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepEditorScriptingUtilities/Public/EditorDataprepAssetLibrary.h

Include

#include "EditorDataprepAssetLibrary.h"

Syntax

UCLASS(Blueprintable, BlueprintType, Meta=(DisplayName="Dataprep Core Blueprint Library"))
class UEditorDataprepAssetLibrary : public UBlueprintFunctionLibrary

Remarks

Utility class to do most expose most of the common functionalities of the dataprep editor plugin (Visual Dataprep).

A Dataprep asset is composed of tree main parts: a array of producers, a recipe and a consumer.

The producers are the objects that manage the logistic of importing the data into the dataprep context For example, a DatasmithFileProducer is an object that can import the data from a file using the datasmith importer

The recipe is a series of DataprepActions. Each action is generally compose of a filter(s) and an operation(s) We refer those as the steps of action. The typical action consist in filtering the dataprep context to get a subset objects and passing those to some operations. Each action receive the full context from the scene and the asset loaded into the dataprep environment.

The consumer is the object that receive the dataprep environment and turns it into something useful and not transient. Currently, the only type of consumer supported is the DatasmithConsumer. It take the dataprep environment and import it into the engine in similar fashion to a standard datasmith import.

More on the dataprep action asset: Each step of dataprep action are a descendant of the type UDataprepParameterizableObject. When setting the value of variables on those objects prefer using the SetEditorProperty utility function as the parameterization of the dataprep asset depends on certain editor calls to stay in sync with the recipe.

Functions

Name Description

Public function Static UFunction BlueprintCallable, Category

UDataprepAct...

 

AddAction

(
    UDataprepAsset* DataprepAsset
)

Add an action to a dataprep asset

Public function Static UFunction BlueprintCallable, Category

UDataprepAct...

 

AddActionByDuplication

(
    UDataprepAsset* DataprepAsset,
    UDataprepActionAsset* ActionTo...
)

Add an action to a dataprep asset

Public function Static UFunction BlueprintCallable, Category, Meta

UDataprepCon...

 

AddProducer

Add a producer to a dataprep asset (The producer will act as if was call from the dataprep editor, use the automated version if you don't want any ui)

Public function Static UFunction BlueprintCallable, Category, Meta

UDataprepCon...

 

AddProducerAutomated

Add a producer to a dataprep asset

Public function Static UFunction BlueprintCallable, Category

UDataprepPar...

 

AddStep

(
    UDataprepActionAsset* Dataprep...,
    TSubclassOf< UDataprepParameterizab...
)

Add a step to a dataprep action

Public function Static UFunction BlueprintCallable, Category

UDataprepPar...

 

AddStepByDuplication

(
    UDataprepActionAsset* Dataprep...,
    UDataprepParameterizableObject*...
)

Add a step to a dataprep action by duplicating the step object

Public function Static UFunction BlueprintCallable, Category

bool

 

ExecuteDataprep

(
    UDataprepAssetInterface* Datap...,
    EDataprepReportMethod LogReportingM...,
    EDataprepReportMethod ProgressRepor...
)

Runs the Dataprep asset's producers, execute its recipe and finally runs the consumer to output the results.

Public function Static UFunction BlueprintCallable, Category

UDataprepAct...

 

GetAction

(
    UDataprepAsset* DataprepAsset,
    int32 Index
)

Get an action from a dataprep asset.

Public function Static UFunction BlueprintCallable, Category

int32

 

GetActionCount

(
    UDataprepAsset* DataprepAsset
)

Get number of actions of a dataprep asset

Public function Static UFunction BlueprintCallable, Category

UDataprepCon...

 

GetConsumer

(
    UDataprepAssetInterface* Datap...
)

Access the consumer of a dataprep asset

Public function Static UFunction BlueprintCallable, Category

UDataprepCon...

 

GetProducer

(
    UDataprepAssetInterface* Datap...,
    int32 Index
)

Get a producer from a dataprep asset.

Public function Static UFunction BlueprintCallable, Category

int32

 

GetProducersCount

(
    const UDataprepAssetInterface*...
)

Get number of the producer of a dataprep asset

Public function Static UFunction BlueprintCallable, Category

UDataprepPar...

 

GetStepObject

(
    UDataprepActionAsset* Dataprep...,
    int32 Index
)

Return the object of a step from the dataprep action

Public function Static UFunction BlueprintCallable, Category

int32

 

GetStepsCount

(
    UDataprepActionAsset* Dataprep...
)

Get the number of steps for a dataprep action

Public function Static UFunction BlueprintCallable, Category

void

 

MoveStep

(
    UDataprepActionAsset* Dataprep...,
    int32 StepIndex,
    int32 DestinationIndex
)

Move a step of the dataprep action

Public function Static UFunction BlueprintCallable, Category

void

 

RemoveAction

(
    UDataprepAsset* DataprepAsset,
    int32 Index
)

Remove an action from a dataprep asset

Public function Static UFunction BlueprintCallable, Category

void

 

RemoveProducer

(
    UDataprepAssetInterface* Datap...,
    int32 Index
)

Remove a producer from a dataprep asset

Public function Static UFunction BlueprintCallable, Category

void

 

RemoveStep

(
    UDataprepActionAsset* Dataprep...,
    int32 Index
)

Remove a step from the action

Public function Static UFunction BlueprintCallable, Category

void

 

SwapActions

(
    UDataprepAsset* DataprepAsset,
    int32 FirstActionIndex,
    int32 SecondActionIndex
)

Swap the actions of a dataprep asset

Public function Static UFunction BlueprintCallable, Category

void

 

SwapSteps

(
    UDataprepActionAsset* Dataprep...,
    int32 FirstIndex,
    int32 SecondIndex
)

Swap the steps of a dataprep action