AddCurves

MLModule
genre Diagram
author Lennart Tautz
package FMEstable/ReleaseMeVis
dll MLAddCurves
definition MLAddCurves.def
see also CurveArithmetic, CurveFilter, CombineCurves
keywords add, curve, sum

Purpose

This module adds up curves in a curve list.

Usage

Connect a curve list and press Update.

Details

Curves are required to have the same domain (same X values for all points).

If the curve list contains only one curve, its values are passed to the output unchanged.

Windows

Default Panel

../../../Projects/AddCurves/Modules/mhelp/Images/Screenshots/AddCurves._default.png

Input Fields

inCurveList

name: inCurveList, type: MLBase

A curve list with at least one curve.

Output Fields

outCurveList

name: outCurveList, type: MLBase

Curve list with single curve that contains the sum of all input values.

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

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.