ExampleCppTileProcessor

MLModule

genre	ML_Inference_Providers_Examples
author	Jan-Martin Kuhnigk
package	FMEstable/ReleaseMeVis
dll	MLExampleCppTileProcessor
definition	MLExampleCppTileProcessor.def
see also	ApplyTileProcessor
keywords	example, test, model

Purpose

Example module for a C++ based TileProcessor. Mostly useful for testing.

Usage

Connect e.g. to ApplyTileProcessor or ProcessTiles and press Update

Windows

Default Panel

Output Fields

outTileProcessor

name: outTileProcessor, type: TileProcessor/TileProcessorContainer(MLBase), deprecated name: outModelConnector

The created TileProcessor.

Parameter Fields

Field Index

[]: Trigger	Input Min Value: Double
Add TileProcessorProperties Object: Bool	On Input Change Behavior: Enum
Clear: Trigger	Processor Type: Enum
doNotClearOnFailedUpdate: Bool	Status Code: Enum
Fill Value: Double	Status Message: String
Force processing error: Bool	Update: Trigger
Has Valid Output: Bool
Input Max Value: Double

Visible Fields

Update

name: update, type: Trigger

Initiates update of all output field values.

Clear

name: clear, type: Trigger

Clears all output field values to a clean initial state.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldAutoUpdate,shouldUpdateAutomatically

Declares how the module should react if a value of an input field changes.

Values:

Title	Name	Deprecated Name
Update	Update	TRUE
Clear	Clear	FALSE

Status Code

name: statusCode, type: Enum, persistent: no

Reflects module’s status (successful or failed computations) as one of some predefined enumeration values.

Values:

Title	Name
Ok	Ok
Invalid input object	Invalid input object
Invalid input parameter	Invalid input parameter
Internal error	Internal error

Status Message

name: statusMessage, type: String, persistent: no

Gives additional, detailed information about status code as human-readable message.

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output field values (success of computation).

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Fill Value

name: inFillValue, type: Double, default: 0.5

Input Min Value

name: inMinValue, type: Double, default: 0

Input Max Value

name: inMaxValue, type: Double, default: 1

Processor Type

name: inProcessorType, type: Enum, default: Identity2x2, deprecated name: inConnectorType

Values:

Title	Name
Identity2x2	Identity2x2
Dummy2x3	Dummy2x3
Scale Min Max1x1	ScaleMinMax1x1

Force processing error

name: inForceProcessingError, type: Bool, default: FALSE, deprecated name: inSimulateProcessTileError

Add TileProcessorProperties Object

name: inAllowProposingTileProcessorProperties, type: Bool, default: FALSE, deprecated name: inAllowProposingTileProperties

Hidden Fields

doNotClearOnFailedUpdate

name: doNotClearOnFailedUpdate, type: Bool, persistent: no

Prevents automated clear after update failed. This does not affect status fields. It enables the developer to analyze module’s state after failure.