SplitList

MLModule

author	Lennart Tautz
package	FMEwork/ReleaseMeVis
dll	MLSplitList
definition	MLSplitList.def
see also	MergeLists, DecomposeBaseList, ExtractObjectFromList
keywords	split, list, head, tail

Purpose

This module splits a list of Base objects into two lists (one head and one tail list).

Usage

Connect a list of Base objects, choose the index to split after and press Update.

Windows

Default Panel

Input Fields

inList

name: inList, type: MLBase

List of Base objects. Must contain at least one object.

Output Fields

outHeadList

name: outHeadList, type: MLBase

List of all objects up to the index given in Split List After Index.

outTailList

name: outTailList, type: MLBase

List of all objects after the index given in Split List After Index.

Parameter Fields

Field Index

[]: Trigger

Clear: Trigger

Has Valid Output: Bool

On Input Change Behavior: Enum

Split List After Index: Integer

Status Code: Enum

Status Message: String

Update: Trigger

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	Description
​Update	​Update	​TRUE	​Update output.
​Clear	​Clear	​FALSE	​Clear output.

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	Description
​Ok	​Ok	​All inputs are OK, output could be updated.
​Invalid input object	​Invalid input object	​The input list was invalid (either there is no list, or it is empty).
​Invalid input parameter	​Invalid input parameter	​The given split index is outside the list size.
​Internal error	​Internal error	​Any other 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).

Split List After Index

name: inSplitAfterIndex, type: Integer, default: 0, minimum: 0

All objects with an index smaller or equal to this will be in the head list, the remaining objects will be in the tail list.

The index must be a valid index in the input list.