UDataprepOperation

Base class for all Dataprep operations Dataprep operations act on a set of input obejcts and can modify their properties: f.e.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

DataprepCore

Header

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

Include

#include "DataprepOperation.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, Blueprintable)
class UDataprepOperation : public UDataprepParameterizableObject

Remarks

Base class for all Dataprep operations Dataprep operations act on a set of input obejcts and can modify their properties: f.e. change materials, add metadata etc.

Functions

Name Description

Protected function UFunction BlueprintCallable, Category

void

 

AssetsModified

(
    TArray< UObject* > Assets
)

Indicates an array of assets has changed during the operation.

Protected function UFunction BlueprintCallable, Category, Meta

void

 

BeginWork

(
    const FText& InDescription,
    float InAmountOfWork
)

Indicates the beginning of a new work to report on

Protected function

TSharedPtr< ...

 

CreateTask

(
    const FText& InDescription,
    float InAmountOfWork,
    float InIncrementOfWork
)

Create a task to report progress during the execution of an operation

Protected function UFunction BlueprintCallable, Category, Meta

void

 

EndWork()

Indicates the end of the work

Public function UFunction BlueprintCallable, Category

void

 

Execute

(
    const TArray< UObject* >& InO...
)

User friendly interface start here ======================================================================.

Public function

void

 

ExecuteOperation

(
    TSharedRef< FDataprepOperationConte...
)

Prepare the operation for the execution and execute it.

Public function Const UFunction Category blueprintnativeevent

FText

 

GetAdditionalKeyword()

Allows to add more keywords for when a user is searching for the fetcher in the ui.

Public function Virtual Const

FText

 

GetAdditionalKeyword_Implementation()

Public function Const UFunction Category blueprintnativeevent

FText

 

GetCategory()

Allows to change the tooltip of the fetcher for the ui if needed.

Public function Virtual Const

FText

 

GetCategory_Implementation()

Public function Const UFunction Category blueprintnativeevent

FText

 

GetDisplayOperationName()

Allows to change the name of the fetcher for the ui if needed.

Public function Virtual Const

FText

 

GetDisplayOperationName_Implementation()

Public function Const UFunction Category blueprintnativeevent

FText

 

GetTooltip()

Allows to change the tooltip of the fetcher for the ui if needed.

Public function Virtual Const

FText

 

GetTooltip_Implementation()

Protected function

bool

 

IsCancelled()

Returns true if the operation was canceled during execution

Protected function UFunction BlueprintCallable, Category, Meta

void

 

LogError

(
    const FText& InLogError
)

Add Error to the log

Protected function UFunction BlueprintCallable, Category, Meta

void

 

LogInfo

(
    const FText& InLogText
)

Add an info to the log

Protected function UFunction BlueprintCallable, Category, Meta

void

 

LogWarning

(
    const FText& InLogText
)

Add a warning to the log

Protected function UFunction blueprintnativeevent

void

 

OnExecution

(
    const FDataprepContext& InContext
)

This function is called when the operation is executed.

Protected function Virtual

void

 

OnExecution_Implementation

(
    const FDataprepContext& InContext
)

This function is the same has OnExcution, but it's the extension point for an operation defined in c++.

Protected function UFunction BlueprintCallable, Category, Meta

void

 

ReportProgress

(
    float IncrementOfWork,
    const FText& InMessage
)

Report foreseen progress on the current work
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss