XMarkerPathLength

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MLXMarkerPathLength
definition	MLXMarkerPathLength.def
see also	TravelingSalesman, ShortestPath
keywords	marker, path, distance, length, distance, curve, graph

Purpose

This module calculates the length of a path, defined by XMarkers.

Usage

Connect an XMarkerList, and press Update.

Details

The path length is calculated as the sum of the distance between consecutive markers. Markers are used as ordered in the XMarkerList. A marker path with one marker has a length of 0.

Windows

Default Panel

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

An XMarkerList with at least one marker.

Parameter Fields

Field Index

[]: Trigger	Update: Trigger
Clear: Trigger
doNotClearOnFailedUpdate: Bool
Has Valid Output: Bool
On Input Change Behavior: Enum
Path Length: Double
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).

Path Length

name: outPathLength, type: Double, persistent: no

The length of the path along the XMarkers.

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.