XMarkerListSinkExample

MLModule

author	Lennart Tautz
package	FMEstable/ReleaseMeVis
dll	MLXMarkerListSinkExample
definition	XMarkerListModuleExamples.def
keywords	example, marker, list, sink, processor, base

Purpose

This modules serves as an example for the XMarkerListSink base class.

Usage

The module takes an XMarkerList, and outputs its size.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

A marker list.

Parameter Fields

Field Index

[]: Trigger	Update: Trigger
Clear: Trigger
doNotClearOnFailedUpdate: Bool
Has Valid Output: Bool
Marker List Size: Integer
On Input Change Behavior: Enum
Status Code: Enum
Status Message: String

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

Marker List Size

name: outMarkerListSize, type: Integer, persistent: no

Size of the connected marker list.

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.