Navigation
API > API/Plugins > API/Plugins/DataprepCore
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UDataprepAssetInterface
- UDataprepAsset
References
| Module | DataprepCore |
| Header | /Engine/Plugins/Enterprise/DataprepEditor/Source/DataprepCore/Public/DataprepAsset.h |
| Include | #include "DataprepAsset.h" |
Syntax
UCLASS&40;BlueprintType&41;
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
| Type | Name | Description | |
|---|---|---|---|
| UDataprepAsset::FRestrictedToActionAsset & | GetOnStepObjectsAboutToBeRemoved | ||
| UDataprepAsset::FDataprepParameterizationStatusForObjectsChanged | OnParameterizedObjectsStatusChanged |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| int32 | AddAction
(
const TArray< const UDataprepActionStep* >& ActionSteps |
Creates an action from the array of action steps or one action per action steps then add the action(s) to the Dataprep asset | |
| int32 | AddAction
(
const UDataprepActionAsset* Action |
Add a copy of the action to the Dataprep asset | |
| int32 | AddActions
(
const TArray< const UDataprepActionAsset* >& Actions |
Add the actions to the Dataprep asset | |
| void | BindObjectPropertyToParameterization
(
UDataprepParameterizableObject* Object, |
||
| bool | |||
| UDataprepActionAsset * | GetAction
(
int32 Index |
||
| const UDataprepActionAsset * | GetAction
(
int32 Index |
||
| int32 | |||
| int32 | GetActionIndex
(
UDataprepActionAsset* ActionAsset |
||
| UDataprepParameterization * | Internal only for now. | ||
| void | |||
| FName | GetNameOfParameterForObjectProperty
(
UDataprepParameterizableObject* Object, |
||
| UDataprepAsset::FOnDataprepActionAssetChange TBaseMulticastDelegate_TwoParams | |||
| UDataprepAsset::FOnStepObjectsAboutToBeRemoved TBaseMulticastDelegate_OneParam | |||
| bool | InsertAction
(
int32 Index |
Creates a new action then insert the action to the Dataprep asset at the requested index | |
| bool | InsertAction
(
const UDataprepActionAsset* InAction, |
Insert a copy of the action to the Dataprep asset at the requested index | |
| bool | InsertAction
(
const TArray< const UDataprepActionStep* >& InActionSteps, |
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 | |
| bool | InsertActions
(
const TArray< const UDataprepActionAsset* >& InActions, |
Insert a copy of each action into the Dataprep asset at the requested index | |
| bool | IsObjectPropertyBinded
(
UDataprepParameterizableObject* Object, |
||
| bool | MoveAction
(
int32 SourceIndex, |
Move an action to another spot in the order of actions This operation take O(n) time. | |
| bool | MoveActions
(
int32 FirstIndex, |
Move group of actions to another spot in the order of actions | |
| bool | RemoveAction
(
int32 Index, |
Remove an action from the Dataprep asset | |
| bool | RemoveActions
(
const TArray< int32 >& Indices, |
Remove a set of actions from the Dataprep asset | |
| void | RemoveObjectPropertyFromParameterization
(
UDataprepParameterizableObject* Object, |
||
| bool | SwapActions
(
int32 FirstActionIndex, |
Swap the actions of a Dataprep asset |
Overridden from UDataprepAssetInterface
| Type | Name | Description | |
|---|---|---|---|
| void | ExecuteRecipe
(
const TSharedPtr< FDataprepActionContext >& InActionsContext |
Sequentially execute all the actions held by the Dataprep asset | |
| const TArray< UDataprepActionAsset * > & | GetActions () |
||
| UObject * | Internal Use only (the current implementation might be subject to change) | ||
| bool | HasActions () |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostDuplicate
(
EDuplicateMode::Type DuplicateMode |
||
| void | PostEditUndo () |
Called after applying a transaction to the object. | |
| void | PostLoad () |
Do any object-specific cleanup required immediately after loading an object. | |
| void | PreEditUndo () |
Called before applying a transaction to the object. | |
| bool | Rename this object to a unique name, or change its outer. |
Classes
| Type | Name | Description | |
|---|---|---|---|
| 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. | ||
| 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 | ||
| FOnStepObjectsAboutToBeRemoved | Allow an observer to be notified of the removal of some step from the asset | ||
| FRestrictedToActionAsset |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< UDataprepContentConsumer > | Consumer_DEPRECATED | DEPRECATED: COnsumer referenced by the asset | |
| TObjectPtr< UBlueprint > | DataprepRecipeBP_DEPRECATED | DEPRECATED: Pointer to data preparation pipeline blueprint previously used to process input data | |
| TArray< FDataprepAssetProducer > | Producers_DEPRECATED | DEPRECATED: List of producers referenced by the asset |