SetMarkerCTUCoordinates

MLModule

author

Lennart Tautz

package

FMEstable/ReleaseMeVis

dll

MLSetMarkerCTUCoordinates

definition

mlSetMarkerCTUCoordinates.def

see also

TranslateXMarkers

keywords

C, T, U, color, time, temporal, user, dimension, coordinate, pos, position, marker

Purpose

This module sets C/T/U for all XMarkers in an XMarkerList.

Usage

Connect an XMarkerList, enter coordinates and press Update.

Windows

Default Panel

../../../Projects/MLMarkerInfrastructure/SetMarkerCTUCoordinates/Modules/mhelp/Images/Screenshots/SetMarkerCTUCoordinates._default.png

Input Fields

inMarkerList

name: inMarkerList, type: MLBase

Input XMarkerList.

Output Fields

outMarkerList

name: outMarkerList, type: MLBase

Copy of the input XMarkerList with set coordinates.

Parameter Fields

Field Index

[]: Trigger

Set U Coordinate: Bool

C Coordinate: Integer

Status Code: Enum

Clear: Trigger

Status Message: String

doNotClearOnFailedUpdate: Bool

T Coordinate: Integer

Has Valid Output: Bool

U Coordinate: Integer

On Input Change Behavior: Enum

Update: Trigger

Set C Coordinate: Bool

Set T Coordinate: Bool

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

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

Set C Coordinate

name: inSetCCoordinate, type: Bool, default: TRUE

Check to set the C coordinate.

C Coordinate

name: inCCoordinate, type: Integer, default: 0

New C coordinate.

Set T Coordinate

name: inSetTCoordinate, type: Bool, default: TRUE

Check to set the T coordinate.

T Coordinate

name: inTCoordinate, type: Integer, default: 0

New T coordinate.

Set U Coordinate

name: inSetUCoordinate, type: Bool, default: TRUE

Check to set the U coordinate.

U Coordinate

name: inUCoordinate, type: Integer, default: 0

New U coordinate.

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.