1. Epic GamesDeveloper
  3. UDataprepOperation

UDataprepOperation

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

API > API/Plugins > API/Plugins/DataprepCore

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.

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

Syntax

UCLASS (Abstract, Blueprintable)  
class UDataprepOperation : public UDataprepParameterizableObject

Inheritance Hierarchy

Derived Classes

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
OperationContext TSharedPtr< const FDataprepOperationContext > Everything below is only for the Dataprep systems internal use =========================================. DataprepOperation.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Execute ( const TArray< UObject* >& InObjects
)

 User friendly interface start here ======================================================================. DataprepOperation.h
  • BlueprintCallable
  • Category="Execution"

void ExecuteOperation ( TSharedRef< FDataprepOperationContext >& InOperationContext
)

 Prepare the operation for the execution and execute it. DataprepOperation.h  

FText GetAdditionalKeyword()

 Allows to add more keywords for when a user is searching for the fetcher in the ui. DataprepOperation.h
  • BlueprintNativeEvent
  • Category="Display|Search"

virtual FText GetAdditionalKeyword_Implementation()

   DataprepOperation.h  

FText GetCategory()

 Allows to change the tooltip of the fetcher for the ui if needed. DataprepOperation.h
  • BlueprintNativeEvent
  • Category="Display"

virtual FText GetCategory_Implementation()

   DataprepOperation.h  

FText GetDisplayOperationName()

 Allows to change the name of the fetcher for the ui if needed. DataprepOperation.h
  • BlueprintNativeEvent
  • Category="Display"

virtual FText GetDisplayOperationName_Implementation()

   DataprepOperation.h  

FText GetTooltip()

 Allows to change the tooltip of the fetcher for the ui if needed. DataprepOperation.h
  • BlueprintNativeEvent
  • Category="Display"

virtual FText GetTooltip_Implementation()

   DataprepOperation.h  

Protected

Name Remarks Include Path Unreal Specifiers

void AssetsModified ( TArray< UObject* > Assets
)

 Indicates an array of assets has changed during the operation. DataprepOperation.h
  • BlueprintCallable
  • Category="Dataprep | Operation"

void BeginWork ( const FText& InDescription,
float InAmountOfWork
)

 Indicates the beginning of a new work to report on DataprepOperation.h
  • BlueprintCallable
  • Category="Report"
  • Meta=(HideSelfPin="true")

TSharedPtr< FDataprepWorkReporter > CreateTask ( const FText& InDescription,
float InAmountOfWork,
float InIncrementOfWork
)

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

void EndWork()

 Indicates the end of the work DataprepOperation.h
  • BlueprintCallable
  • Category="Report"
  • Meta=(HideSelfPin="true")

bool IsCancelled()

 Returns true if the operation was canceled during execution DataprepOperation.h  

void LogError ( const FText& InLogError
)

 Add Error to the log DataprepOperation.h
  • BlueprintCallable
  • Category="Log"
  • Meta=(HideSelfPin="true")

void LogInfo ( const FText& InLogText
)

 Add an info to the log DataprepOperation.h
  • BlueprintCallable
  • Category="Log"
  • Meta=(HideSelfPin="true")

void LogWarning ( const FText& InLogText
)

 Add a warning to the log DataprepOperation.h
  • BlueprintCallable
  • Category="Log"
  • Meta=(HideSelfPin="true")

void OnExecution ( const FDataprepContext& InContext
)

 This function is called when the operation is executed. DataprepOperation.h
  • BlueprintNativeEvent

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++. DataprepOperation.h  

void ReportProgress ( float IncrementOfWork,
const FText& InMessage
)

 Report foreseen progress on the current work DataprepOperation.h
  • BlueprintCallable
  • Category="Report"
  • Meta=(HideSelfPin="true")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page