Sublist

MLModule
author Lennart Tautz
package FMEwork/ReleaseMeVis
dll MLSublist
definition MLSublist.def
see also SplitList, MergeLists, DecomposeBaseList
keywords base, list, object, range, extract

Purpose

This module extracts a sublist from any ListBase object.

Usage

Connect a Base object that is derived from ListBase, select a valid subrange and press Update.

Windows

Default Panel

../../../Projects/ListBaseInfrastructure/MLSublist/Modules/mhelp/Images/Screenshots/Sublist._default.png

Input Fields

inList

name: inList, type: MLBase

A ListBase-derived Base object.

Output Fields

outList

name: outList, type: MLBase

An object of the same type as the input object, reduced to a subrange of the contained elements.

Parameter Fields

Field Index

[]: Trigger Update: Trigger
Clear: Trigger  
End Index: Integer  
Has Valid Output: Bool  
On Input Change Behavior: Enum  
Start Index: Integer  
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: 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 outputs.
Clear Clear FALSE Clear outputs.

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 Inputs could be processed.
Invalid input object Invalid input object The input object is invalid, e.g., NULL or not ListBase-derived.
Invalid input parameter Invalid input parameter The input parameters are invalid, e.g., the indicated range is not within the input object range.
Internal error Internal error An internal error occurred.

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

Start Index

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

First (inclusive) index of the subrange to extract.

End Index

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

Last (inclusive) index of the subrange to extract.