BaseClear

MLModule

genre	Fields
author	MeVis Medical Solutions AG
package	MeVisLab/Standard
dll	MLBasicModules
definition	mlBasicModules.def
see also	ImageClear, BaseBypass
keywords	field, notification, flow, control

Purpose

The module BaseClear can be used to automatically pass through or invalidate a Base object.

Usage

Connect a Base field to the input of the module and select if the output should be automatically updated with Update automatically.

With Update or Clear, the output can be updated or cleared manually.

Tips

Note that some Base object type have an internal notification mechanism that is not (and cannot be) affected by this module.

Windows

Default Panel

Input Fields

inBase

name: inBase, type: MLBase

Connect any Base field here.

Output Fields

outBase

name: outBase, type: MLBase

The output is either inBase or NULL.

Parameter Fields

Field Index

Clear: Trigger

Has Valid Input: Bool

Has Valid Output: Bool

Update: Trigger

Update automatically: Bool

Visible Fields

Has Valid Input

name: validInput, type: Bool, persistent: no

Has Valid Output

name: validOutput, type: Bool, persistent: no

Update automatically

name: autoUpdate, type: Bool, default: FALSE

If checked, the output will always get the same value as the input, but only after the input has been touched first.

Otherwise, any touching of the Base input field will set the output to NULL. Unnecessary notifications will be suppressed.

Update

name: update, type: Trigger

When pressed, the output Base field is updated to the input Base field’s value. This will always trigger a notification on the output field.

Clear

name: clear, type: Trigger

When pressed, the output Base field is set to NULL. If the output field is already NULL, nothing will be done.