ExampleCSOAlgorithmModule

MLModule

author	Grzegorz Chlebus
package	FMEstable/ReleaseMeVis
dll	MLCSOAlgorithmModule
definition	MLCSOAlgorithmModule.def
keywords	cso, base, algorithm

Purpose

This module is an example of using the CSOAlgorithmModule base class.

Usage

Provide an input CSO list with at least one CSO. Select the input offset in the module panel and press Update.

Details

This module dilates each CSO from the input list by a distance. i.e. computes buffer of the CSOs. The resulting area is output in the outArea field.

Windows

Default Panel

Input Fields

inCSOList0

name: inCSOList0, type: MLBase

Input CSO list

Output Fields

outCSOList

name: outCSOList, type: MLBase

Output list containing the dilated CSOs.

Parameter Fields

Field Index

[]: Trigger	Status Message: String
Clear: Trigger	Update: Trigger
doNotClearOnFailedUpdate: Bool
Has Valid Output: Bool
In Offset: Double
On Input Change Behavior: Enum
Out Area: Double
Status Code: Enum

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: shouldUpdateAutomatically,shouldAutoUpdate

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).

Out Area

name: outArea, type: Double, persistent: no

Total (accumulated) area of the output CSOs.

In Offset

name: inOffset, type: Double, default: 0, minimum: 0

Input dilation distance.

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.