User Reference:Operator Module Scripting - Revision history

Mellinger: /* Associating Scripts with Operator Events */

2026-11-11T14:22:57Z

Associating Scripts with Operator Events

← Older revision		Revision as of 14:22, 11 November 2026
Line 648:		Line 648:
	In the operator module's preferences dialog, script commands may be entered for each of the handlers listed above.		In the operator module's preferences dialog, script commands may be entered for each of the handlers listed above.
	Scripts may be specified as paths to script files, or as immediate one-line scripts.		Scripts may be specified as paths to script files, or as immediate one-line scripts.
	Entries that start with a minus sign (-) are treated as one-line scripts, ~~which~~ may contain multiple commands separated with semicolons.		Entries that start with a minus sign (-) are treated as one-line scripts. Being restricted to a single line, one-line scripts may still contain multiple commands separated with semicolons.

	Scripts may also be specified from the command line used to start up the operator module. There, handler names are followed with the content of the respective preference entry, enclosed in double quotes ("...").		Scripts may also be specified from the command line used to start up the operator module. There, handler names are followed with the content of the respective preference entry, enclosed in double quotes ("...").

Mellinger: /* OnExit */

2026-11-11T14:21:50Z

OnExit

← Older revision		Revision as of 14:21, 11 November 2026
Line 643:		Line 643:

	====OnExit====		====OnExit====
	Triggered when the operator module exits. Execution of the QUIT command also triggers this handler. This handler is not available to the SET SCRIPT and CLEAR SCRIPT commands. Also, when both an OnShutdown and an OnExit script are defined, the OnExit script may be executed before the OnShutdown script.		Triggered when the operator module exits. Execution of the QUIT command also triggers this handler. This handler is not available to the SET SCRIPT and CLEAR SCRIPT commands. Also, when both an ''OnShutdown'' and an ''OnExit'' script are defined, the ''OnExit'' script may be executed before the ''OnShutdown'' script.

	====Associating Scripts with Operator Events====		====Associating Scripts with Operator Events====

Mellinger: /* OnShutdown */

2026-11-11T14:21:01Z

OnShutdown

← Older revision		Revision as of 14:21, 11 November 2026
Line 640:		Line 640:

	====OnShutdown====		====OnShutdown====
	Triggered when the operator module shuts down connections, and switches ~~into~~ idle state.		Triggered when the operator module shuts down connections, and switches to idle state.

	====OnExit====		====OnExit====

Mellinger: /* OnStartRun */

2026-11-11T14:20:34Z

OnStartRun

← Older revision		Revision as of 14:20, 11 November 2026
Line 630:		Line 630:
	Similarly to ''OnStart'' and ''OnResume'', this handler is triggered by the ''Start''/''Resume'' button. Unlike other event handlers, ''OnStartRun'' has an argument, which is the current run file.		Similarly to ''OnStart'' and ''OnResume'', this handler is triggered by the ''Start''/''Resume'' button. Unlike other event handlers, ''OnStartRun'' has an argument, which is the current run file.

	''OnStart'' or ''OnResume'' are triggered immediately after ''Start''/''Resume'' has been pressed, whereas ''OnStartRun'' is deferred until modules have confirmed to be in Running state. This makes sure that the ''OnStartRun'' event handler receives a valid run file name.		''OnStart'' or ''OnResume'' are triggered immediately after ''Start''/''Resume'' has been pressed, whereas ''OnStartRun'' is deferred until modules have confirmed to be in ''Running'' state. This makes sure that the ''OnStartRun'' event handler receives a valid run file name.

	====OnNextFilePart====		====OnNextFilePart====

Mellinger: /* OnStartRun */

2026-11-11T14:19:56Z

OnStartRun

← Older revision		Revision as of 14:19, 11 November 2026
Line 628:		Line 628:

	====OnStartRun====		====OnStartRun====
	Similarly to OnStart and OnResume, this handler is triggered by the ''Start''/''Resume'' button. Unlike other event handlers, OnStartRun has an argument, which is the current run file.		Similarly to ''OnStart'' and ''OnResume'', this handler is triggered by the ''Start''/''Resume'' button. Unlike other event handlers, ''OnStartRun'' has an argument, which is the current run file.

	OnStart or OnResume are triggered immediately after ''Start''/''Resume'' has been pressed, whereas OnStartRun is deferred until modules have confirmed to be in Running state. This makes sure that the OnStartRun event handler receives a valid run file name.		''OnStart'' or ''OnResume'' are triggered immediately after ''Start''/''Resume'' has been pressed, whereas ''OnStartRun'' is deferred until modules have confirmed to be in Running state. This makes sure that the ''OnStartRun'' event handler receives a valid run file name.

	====OnNextFilePart====		====OnNextFilePart====

Mellinger: /* START TELNET [], STOP TELNET [] */

2026-11-11T14:13:42Z

START TELNET [], STOP TELNET []

← Older revision		Revision as of 14:13, 11 November 2026
Line 541:		Line 541:
	If the system is in ''Running'' state, the text will also be added to the current notes file as described under		If the system is in ''Running'' state, the text will also be added to the current notes file as described under
	[[User_Reference:Operator_Notes#Note_storage_and_file_format\|"notes file"]].		[[User_Reference:Operator_Notes#Note_storage_and_file_format\|"notes file"]].

			=====START PIPE [<name>], STOP PIPE [<name>]=====
			Starts or stops a named pipe server listening at the pipe with the given name, located in the global temporary directory. The default name is <tt>bci20000_Operator</tt>. For named pipes, access control is implemented through file system permissions, so it is a safe way to control the Operator module from local client programs.

	=====START TELNET [<address>], STOP TELNET [<address>]=====		=====START TELNET [<address>], STOP TELNET [<address>]=====

Mellinger: /* RECORD VISUALIZATION [on|off] */

2026-11-11T14:06:23Z

RECORD VISUALIZATION [on|off]

← Older revision		Revision as of 14:06, 11 November 2026
Line 528:		Line 528:

	=====RECORD VISUALIZATION <visID> [on\|off]=====		=====RECORD VISUALIZATION <visID> [on\|off]=====
	Registers the named visualization for recording. The visualization name must be the short name as displayed in the ''View->Visualizations'' menu. Switching a visualization recording to "on" is only possible in idle state (because an event for recording frame numbers must be registered in the system). When a visualization is registered for recording, its frames are stored immediately as they arrive at the operator module.		Registers the named visualization for recording. The visualization name must be the short name as displayed in the ''View→Visualizations'' menu. Switching a visualization recording to "on" is only possible in idle state (because an event for recording frame numbers must be registered in the system). When a visualization is registered for recording, its frames are stored immediately as they arrive at the operator module.

	Example: Recording the application window		Example: Recording the application window

Mellinger: /* MOVE VISUALIZATON , RESIZE VISUALIZATION */

2026-11-11T14:05:36Z

MOVE VISUALIZATON , RESIZE VISUALIZATION

← Older revision		Revision as of 14:05, 11 November 2026
Line 516:		Line 516:
	=====MOVE VISUALIZATON <visID> <x> <y>, RESIZE VISUALIZATION <visID> <width> <height>=====		=====MOVE VISUALIZATON <visID> <x> <y>, RESIZE VISUALIZATION <visID> <width> <height>=====
	Moves resp. resizes the specified visualization window.		Moves resp. resizes the specified visualization window.
	Window decorations (title bar, frame) are taken into consideration such that the total size of the window matches the given width and height. If unknown, visualization IDs may be obtained from the Operator's ''Window->Visualizations'' menu.		Window decorations (title bar, frame) are taken into consideration such that the total size of the window matches the given width and height. If unknown, visualization IDs may be obtained from the Operator's ''Window→Visualizations'' menu.

	=====ARRANGE VISUALIZATION <visID> <rows> <cols> <row> <col> [<rowspan> <colspan>]=====		=====ARRANGE VISUALIZATION <visID> <rows> <cols> <row> <col> [<rowspan> <colspan>]=====

Mellinger: /* VISUALIZE WATCH [decimate ] [range ] ... */

2026-11-11T14:03:24Z

VISUALIZE WATCH [decimate ] [range ] ...

← Older revision		Revision as of 14:03, 11 November 2026
Line 511:		Line 511:
	Adds a watch for the given expressions to the operator module's Watches area, and makes the Visualization dock window visible if it is hidden. If the ''decimate'' clause is present, the command will create a watch which will be evaluated only for every ''n''th sample in the state vector. If the ''range'' clause is present, display minimum and maximum will not be adjusted automatically but will be fixed to the values given.		Adds a watch for the given expressions to the operator module's Watches area, and makes the Visualization dock window visible if it is hidden. If the ''decimate'' clause is present, the command will create a watch which will be evaluated only for every ''n''th sample in the state vector. If the ''range'' clause is present, display minimum and maximum will not be adjusted automatically but will be fixed to the values given.

	By default, ''decimate'' has a value of "auto"; this means that there is no decimation of evaluation (i.e., all samples are evaluated) but changes that occur within 1ms will be shortened into their maximum and minimum, and thus reported as only two values.		By default, ''decimate'' has a value of "auto"; this means that there is no decimation of evaluation (i.e., all samples are evaluated), but multiple changes that occur within 1ms will be shortened into their maximum and minimum, and thus reported as only two values.
	This has proven to be efficient for avoiding sluggishness from flooding the application with events.		This has proven to be efficient for avoiding sluggishness from flooding the application with events.

Mellinger: /* VISUALIZE WATCH [decimate ] [range ] ... */

2026-11-10T14:45:35Z

VISUALIZE WATCH [decimate ] [range ] ...

← Older revision		Revision as of 14:45, 10 November 2026
Line 509:		Line 509:

	=====VISUALIZE WATCH [decimate <n>] [range <min> <max>] <expression1> ...=====		=====VISUALIZE WATCH [decimate <n>] [range <min> <max>] <expression1> ...=====
	Adds a watch for the given expressions to the operator module's Watches ~~window~~, and makes the ~~Watches~~ window visible if it is hidden. If the ''decimate'' clause is present, the command will create a watch which will be evaluated only for every ''n''th sample in the state vector. If the ''range'' clause is present, display minimum and maximum will not be adjusted automatically but will be fixed to the values given.		Adds a watch for the given expressions to the operator module's Watches area, and makes the Visualization dock window visible if it is hidden. If the ''decimate'' clause is present, the command will create a watch which will be evaluated only for every ''n''th sample in the state vector. If the ''range'' clause is present, display minimum and maximum will not be adjusted automatically but will be fixed to the values given.

	By default, ''decimate'' has a value of "auto"; this means that there is no decimation of evaluation (i.e., all samples are evaluated) but changes that occur within 1ms will be shortened into their maximum and minimum, and thus reported as only two values.		By default, ''decimate'' has a value of "auto"; this means that there is no decimation of evaluation (i.e., all samples are evaluated) but changes that occur within 1ms will be shortened into their maximum and minimum, and thus reported as only two values.