UserIO

From SweepMe! Wiki
Jump to navigation Jump to search

version: 1.5.5

The module 'UserIO' is used to interact with the user, e.g. to ask for a value (Input) or to display some information (Output).

For all types, you can enter a message. The message field can be used in combination with the Parameter system to change messages during the run.

Fields

Depending on the selected type, the following fields are shown:

  • Message: the text shown to the user. Available for all types.
  • Variable: only for input types. The entered value is returned as a variable with this name and can be used by other modules, e.g. with the Parameter system.
  • Unit: only for Float. The unit of the returned variable.
  • Minimum and Maximum: only for Integer and Float. The limits of the value the user can enter. Leave them empty for no limit.
  • Choices: only for Selection. Options separated by a | character.
  • Blocking: only for the MessageBox types. A blocking message box interrupts the run until the user confirms it. A non-blocking message box is displayed and the run continues immediately.
  • Close afterwards: only for the MessageBox types. A non-blocking message box is hidden automatically after the branch in which the UserIO module is used is left.

Input

All input types are blocking, i.e. the user needs to enter a value and accept the dialog before the program run continues. Input windows are displayed in the start() phase.

String

Ask the user to enter a string.

Integer

Ask the user to enter an integer.

Float

Ask the user to enter a float.

Selection

Ask the user to select from different options. Possible values can be entered in the field choices, separated by a | character.

Output

Some output types can be made 'blocking'. Then, the program will stop and wait for the user to accept the message. Output windows are displayed in the finish() phase of the sequencer.

MessageBox (Warning)

Display a message box with warning symbol.

MessageBox (Information)

Display a message box with information symbol.

MessageBox (Critical)

Display a message box with critical symbol.

MessageInfo

Display a message in the info field of the General tab.

MessageBalloon

Display a message in a message balloon.

Debug

Add a message to the debug output.

WriteLog

Add a message to the Logbook file.