BaseBypassOp¶

MLModule¶

genre	`Fields`
status	`stable`
author	`Markus Krebs`
package	`MeVisLab/Standard`
dll	`MLBasicModules`
definition	mlBasicModules.def
see also	`Bypass`
keywords	`bypass`, `base`, `field`, `notification`, `XMarker`

Purpose¶

The BaseBypassOp module transmits the input base value without any operations.

It can also control notifications.

Usage¶

Just connect the input base field and the output base field.

Windows¶

Default Panel¶

../../../Modules/ML/MLBasicModules/mhelp/Images/Screenshots/BaseBypassOp._default.png

Input Fields¶

inBaseField¶

name: inBaseField, type: MLBase, deprecated name: inCurves¶

Output Fields¶

outBaseField¶

name: outBaseField, type: MLBase, deprecated name: outCurves¶

Parameter Fields¶

Field Index¶

Clear: Trigger

Count Notifications: Integer

Enable Bypass: Bool

New Notifications Available: Bool

Update: Trigger

Visible Fields¶

Enable Bypass¶

name: enableBypass, type: Bool, default: FALSE, deprecated name: bypassEnabled¶

If checked, every notification at the input forces a copy of the input base value pointer to the output base field, that means all notifications are forwarded.

Otherwise, notifications are blocked, the incoming notifications are counted, the New Notifications Available field will be updated.

Update¶

name: update, type: Trigger¶: If pressed, a copy of the input base value pointer is set to the output base field, thus creating a single notification.

Clear¶

name: clear, type: Trigger¶: Sets the base value pointer of the output base field to NULL, thus creating a single notification.

New Notifications Available¶

name: newNotificationsAvailable, type: Bool, default: FALSE¶

Shows whether there are any notifications which were not forwarded yet.

Will be reset after forwarding a notification by automatic bypassing, Update or Clear.

Count Notifications¶

name: countNotifications, type: Integer, default: 0¶

Shows the number of notifications which were not forwarded.