ReverseList

MLModule

author

Lennart Tautz

package

FMEwork/ReleaseMeVis

dll

MLReverseList

definition

MLReverseList.def

see also

Sublist, SplitList, MergeLists, DecomposeBaseList

keywords

base, list, object, reverse, revert, inverse, invert

Purpose

This module reverses any ListBase object.

Usage

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

Windows

Default Panel

../../../Projects/ListBaseInfrastructure/ReverseList/Modules/mhelp/Images/Screenshots/ReverseList._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, with reversed element order.

Parameter Fields

Field Index

[]: Trigger

Clear: Trigger

doNotClearOnFailedUpdate: Bool

Has Valid Output: Bool

On Input Change Behavior: Enum

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

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

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.