CurveCompare

MLModule

genre	Analysis
author	Daniel Romberg
package	FMEstable/ReleaseMeVis
dll	MLCurveCompare
definition	MLCurveCompare.def
see also	ImageCompare, DicomTreeCompare, PCLCompare
keywords	curve, compare, equal

Purpose

Module is used to compare two CurveList or CurveData objects for equality.

Usage

Connect two input CurveList objects and set up indices of CurveData objects you want to compare. Also you can directly connect a CurveData object to an input for comparison. In this case input indices are ignored. If you want to compare complete input CurveList objects enable related BoolField. In this case input indices are also ignored.

Windows

Default Panel

Input Fields

inCurve0

name: inCurve0, type: MLBase

CurveData or CurveList object for comparison.

inCurve1

name: inCurve1, type: MLBase

CurveData or CurveList object for comparison.

Parameter Fields

Field Index

[]: Trigger	Index Curve 1: Integer
Are Equal: Bool	On Input Change Behavior: Enum
Clear: Trigger	Status Code: Enum
Compare CurveLists: Bool	Status Message: String
doNotClearOnFailedUpdate: Bool	Update: Trigger
Epsilon: Double
Has Valid Output: Bool
Index Curve 0: Integer

Visible Fields

Update

name: update, type: Trigger

Updates output.

Clear

name: clear, type: Trigger

Clears output.

On Input Change Behavior

name: onInputChangeBehavior, type: Enum, default: Clear, deprecated name: shouldAutoUpdate,shouldUpdateAutomatically

If enabled output will be updated automatically after change of any input field. If disabled output will automatically be cleared.

Values:

Title	Name	Deprecated Name
​Update	​Update	​TRUE
​Clear	​Clear	​FALSE

Status Code

name: statusCode, type: Enum, persistent: no

Status code to indicate successful or failed computations.

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

Detail message of the status.

Has Valid Output

name: hasValidOutput, type: Bool, persistent: no

Indicates validity of output (success of calculation).

[]

name: updateDone, type: Trigger, persistent: no

Notifies that an update was performed (Check status interface fields to identify success or failure).

Index Curve 0

name: inCurrentInCurve0Index, type: Integer, default: 0, deprecated name: currentInCurve0Index

Selects curve with given index from first input CurveList. Index is ignored if comparison of CurveLists is enabled.

Index Curve 1

name: inCurrentInCurve1Index, type: Integer, default: 0, deprecated name: currentInCurve1Index

Selects curve with given index from second input CurveList. Index is ignored if comparison of CurveLists is enabled.

Epsilon

name: inEpsilon, type: Double, default: 0.001, deprecated name: epsilon

Allowed deviation of values.

Compare CurveLists

name: inShouldCompareCurveLists, type: Bool, default: FALSE

Declares if all CurveData objects from connected CurveLists should be compared. If enabled the input indices are ignored.

Are Equal

name: outAreEqual, type: Bool, persistent: no, deprecated name: areEqual

Result of comparison.

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.