UDataprepContentProducer

Abstract class to derived from to be a producer in the Dataprep asset

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UDataprepContentProducer

References

Module

DataprepCore

Header

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

Include

#include "DataprepContentProducer.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Abstract, BlueprintType)
class UDataprepContentProducer : public UObject

Remarks

Abstract class to derived from to be a producer in the Dataprep asset

Variables

Name Description

Protected variable

FDataprepProduc...

 

Context

Context which the producer will run with

Protected variable

TSharedPtr< FFe...

 

FeedbackContext

The feedback context in use to check for user cancellation

Protected variable

FDataprepProduc...

 

OnChanged

Delegate to broadcast changes to the producer

Functions

Name Description

Public function Virtual

bool

 

CanAddToProducersArray

(
    bool bIsAutomated
)

Allow a producer to pop a ui after being created.

Protected function Virtual

bool

 

Execute

(
    TArray< TWeakObjectPtr< UObject > >...
)

Populates the world and fill up the array of assets.

Public function Virtual Const

const FText ...

 

GetDescription()

Text briefly describing what the producer is doing to populate the world and assets.

Public function Virtual Const

const FText ...

 

GetLabel()

Name used by the UI to be displayed.

Public function Virtual Const

FString

 

GetNamespace()

Text briefly describing what the producer is doing to populate the world and assets.

Public function

UDataprepCon...

 

GetOnChanged()

Protected function Virtual

bool

 

Initialize()

Initialize the producer to be ready for a call to the Execute method.

Public function

bool

 

IsCancelled()

Returns true if the producer was cancelled during execution

Protected function

bool

 

IsValid()

Protected function

void

 

LogError

(
    const FText& Message
)

Protected function

void

 

LogInfo

(
    const FText& Message
)

Start of helper functions to log messages and report progress.

Protected function

void

 

LogWarning

(
    const FText& Message
)

Public function

bool

 

Produce

(
    const FDataprepProducerContext& In...,
    TArray< TWeakObjectPtr< UObject > >...
)

Successively calls the Initialize, Execute and Reset methods Additionally, to avoid naming collision, rename the newly created actors to include the producer's namespace.

Protected function Virtual

void

 

Reset()

Clean up the objects used by the producer.

Public function Virtual Const

bool

 

Supersede

(
    const UDataprepContentProducer*...
)

A producer supersede another if its produces the same content or a super-set of the other's content

Classes

Name

Description

Public class

FDataprepProducerChanged

Allow an observer to be notified when one of the properties of the producer changes

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