NetworkNotifyer

MacroModule

genre	Test
author	Wolf Spindler
package	FMEstable/ReleaseMeVis
definition	NetworkNotifyer.def
see also	CommandNotifier
keywords	trigger, touch, start, iterate, buttons, notifications, notify, commands, execute, execution, count, increment

Purpose

This module is a small helper for starting and running test networks, and to start or iterate over a range of indices. All buttons in this module are explicitly shown with their labels to simplify connecting them with other fields.

Windows

Default Panel

Parameter Fields

Field Index

Auto Run: Bool	Minimum: Integer
Compare: Trigger	Reset To Min: Trigger
Counter: Integer	Save: Trigger
Delayed Trigger: Trigger	Step Time (ms): Integer
delayedTriggerInQueue: Bool	Stop Run: Trigger
Increment: Integer	Trigger Once: Trigger
Load: Trigger	Trigger Range: Trigger
Maximum: Integer

Visible Fields

Load

name: load, type: Trigger, deprecated name: button1

This is a button doing nothing, it is meant as connector to (perhaps multiple) other fields which do something like a load operation.

Save

name: save, type: Trigger, deprecated name: button2

This is a button doing nothing, it is meant as connector to (perhaps multiple) other fields which do something like a save operation.

Compare

name: compare, type: Trigger, deprecated name: button3

This is a button doing nothing, it is meant as connector to (perhaps multiple) other fields which do something like a compare operation.

Trigger Once

name: triggerOnce, type: Trigger, deprecated name: button4

If triggered, this button increments Counter by the value given in Increment. It can be connected to other fields which shall do something. This field may also be triggered indirectly by Trigger Range as many times as are needed to increment Counter before it is equal or larger than Maximum.

Delayed Trigger

name: delayedTrigger, type: Trigger

This field is triggered as soon as possible after Trigger Once is triggered and is not meant to be pressed or triggered directly, that means it should be considered an output field. It will always be executed before another Trigger Range cycle is executed if Trigger Once was triggered by Trigger Range. This is especially useful to give other parts in a module network some time to complete their updates which often cannot be done by a direct notification caused by Trigger Once.

Trigger Range

name: triggerRange, type: Trigger

This button triggers Trigger Once as long as the value of Counter is smaller than Maximum. It waits at least Step Time (ms) between two trigger operations. To restart triggering the entire range after completing one Reset To Min can be pressed.

Stop Run

name: stopRun, type: Trigger

When Trigger Range was notified to traverse the full range of [Minimum, Maximum] then this button can be used to stop the triggering by setting Counter to Maximum.

Reset To Min

name: resetToMin, type: Trigger

This sets Counter to the value of Minimum.

Counter

name: counter, type: Integer, default: 0, minimum: :field:`minimum`, maximum: :field:`maximum`

Counter is incremented by Increment each time when Trigger Once is notified. When it reaches Maximum it is not incremented any more even if Trigger Once or Trigger Range is notified.

Increment

name: increment, type: Integer, default: 1

This value is used to increment Counter on each Trigger Once notification and therefore also indirectly when Trigger Range is touched.

Minimum

name: minimum, type: Integer, default: 0

This value is used for resetting counter when Reset To Min is pressed.

Maximum

name: maximum, type: Integer, default: 100

This value is the maximum limit for counter when Trigger Once or Trigger Range is pressed.

Step Time (ms)

name: stepTime, type: Integer, default: 50, minimum: 10

This value is waited between two Trigger Once notifications when they are triggered by Trigger Range or when Auto Run is enabled and it executes Trigger Range automatically after cloning or reloading the network.

Auto Run

name: autoRun, type: Bool, default: FALSE

If enabled the Trigger Range is pressed automatically after reloading or cloning module networks. This typically is used to tart network operations or tests automatically when networks without user interaction.

Hidden Fields

delayedTriggerInQueue

name: delayedTriggerInQueue, type: Bool, persistent: no