XMarkerListCompare

MLModule

genre	Analysis
author	Torben Paetz
package	FMEstable/ReleaseMeVis
dll	MLXMarkerListCompare
definition	MLXMarkerListCompare.def
keywords	XMarker, XMarkerList, compare, equal, comparison

Purpose

Module is used to compare two XMarkerList objects for equality.

Usage

Connect two input XMarkerList objects you want to compare.

You can specify epsilon comparison for the position (Vector6) and vector (Vector3) of the XMarker. The epsilon comparison is performed on the length of the difference vector between the XMarker’s position resp. vector that are compared.

Details

Note that the marker ID is never checked in the comparison.

Windows

Default Panel

Input Fields

inXMarkerList0

name: inXMarkerList0, type: MLBase

XMarkerList object for comparison.

inXMarkerList1

name: inXMarkerList1, type: MLBase

XMarkerList object for comparison.

Parameter Fields

Field Index

[]: Trigger	Has Valid Output: Bool
Also compare marker names: Bool	On Input Change Behavior: Enum
Are Equal: Bool	Status Code: Enum
Clear: Trigger	Status Message: String
Compare marker types: Bool	Update: Trigger
doNotClearOnFailedUpdate: Bool
Epsilon position: Double
Epsilon vector: Double

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 any input field value changes. If set to True the output field values will be updated. Otherwise they will be cleared.

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

Epsilon position

name: inEpsilonPosition, type: Double, default: 0.001

Allowed deviation of 6D XMarker positions.

Epsilon vector

name: inEpsilonVector, type: Double, default: 0.001

Allowed deviation of 3D XMarker vectors.

Also compare marker names

name: inEnableMarkerNameComparison, type: Bool, default: TRUE

Enables/disables the comparison of marker names. As a BaseItem, each marker also has a name.

Compare marker types

name: inShouldCompareMarkerTypes, type: Bool, default: TRUE

Are Equal

name: outAreEqual, type: Bool, persistent: no

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.