FieldBypass

MLModule
genre Fields
status stable
author Tobias Boehler
package MeVisLab/Standard
dll MLMiscModules
definition MLMiscModules.def
keywords field, notification, switch

Purpose

The module FieldBypass allows to turn field notifications of four field on or off.

This way, fields connected using this module can be bypassed. This module can also be used to select between any of the input fields.

Details

Since module fields will almost always be updated when they are connected, a lot of computational time is required even when updating or connecting individual fields.

The FieldBypass module allows the selective update of the connected output field (just like the Bypass module does for images).

Windows

Default Panel

../../../Modules/ML/MLMiscModules/mhelp/Images/Screenshots/FieldBypass._default.png

Parameter Fields

Field Index

Input Field 0: String Output Field: String
Input Field 1: String Update: Trigger
Input Field 2: String  
Input Field 3: String  
Input Field 4: String  
Input Selector: Integer  
No bypass: Bool  
Only if changed: Bool  

Visible Fields

Input Field 0

name: inputString0, type: String, deprecated name: inputString

First input field, connected via string conversion.

Input Field 1

name: inputString1, type: String

Second input field, connected via string conversion.

Input Field 2

name: inputString2, type: String

Third input field, connected via string conversion.

Input Field 3

name: inputString3, type: String

Fourth input field, connected via string conversion.

Input Field 4

name: inputString4, type: String

Fifth input field, connected via string conversion.

Input Selector

name: inputNumber, type: Integer, default: 0, minimum: -1, maximum: 4

Sets which input field to propagate to the output field (-1 for the last touched).

Output Field

name: outputString, type: String

The output field, connected via string conversion.

No bypass

name: noBypass, type: Bool, default: FALSE

If checked, no changes are propagated from any input field to the output field.

Only if changed

name: onlyIfChanged, type: Bool, default: TRUE

If checked, only real value changes on the output field generate a notification.

Update

name: update, type: Trigger

If pressed, the output field is forced an update even if the value has not changed.

This button is shown on the GUI as a field to enable field connections to it.