FilterCurveList

MLModule

author	Lennart Tautz
package	FMEstable/ReleaseMeVis
dll	MLFilterCurveList
definition	MLFilterCurveList.def
see also	CurveSelect, ExtractCurveData
keywords	curve, list, curve, data, filter, select, property

Purpose

The module filters curves from a curve list.

Usage

Connect a curve list, select filters to keep certain curves, and press Update.

Windows

Default Panel

Input Fields

inCurveList

name: inCurveList, type: MLBase

Original curve list.

Output Fields

outCurveList

name: outCurveList, type: MLBase

Filtered curve list.

Parameter Fields

Field Index

[]: Trigger	Status Code: Enum
Clear: Trigger	Status Message: String
doNotClearOnFailedUpdate: Bool	Style to Keep: Integer
Filter by curve style: Bool	Title to Keep: String
Filter by curve title: Bool	Update: Trigger
Has Valid Output: Bool
Match substring of title: Bool
On Input Change Behavior: Enum

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

Filter by curve title

name: inFilterByTitle, type: Bool, default: FALSE

If checked, only curves with the given title are kept

Match substring of title

name: inMatchSubstringOfTitle, type: Bool, default: FALSE

If checked, the criterion title can be a substring of the curve title

Title to Keep

name: inTitleCriterion, type: String

Curves with this title are kept

Filter by curve style

name: inFilterByStyle, type: Bool, default: FALSE

If checked, only curves with the given style are kept

Style to Keep

name: inStyleCriterion, type: Integer, default: 0

Curves with this style are kept

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.