Dialog

SCPI Commands :

DISPlay:DIALog:CLOSe
DISPlay:DIALog:CLOSe:ALL
DISPlay:DIALog:ID
DISPlay:DIALog:OPEN

Commands in total: 4

Subgroups: 0

Direct child commands: 4

close(dialog_id: str) → None

# DISPlay:DIALog:CLOSe
driver.display.dialog.close(dialog_id = 'abc')

Closes the specified dialog.

Parameters:

dialog_id – string To find out the dialog identifier, use the query method RsSmw.display.dialog.id() . The DialogName part of the query result is sufficient.

close_all() → None

# DISPlay:DIALog:CLOSe:ALL
driver.display.dialog.close_all()

Closes all open dialogs.

close_all_with_opc(opc_timeout_ms: int = -1) → None

# DISPlay:DIALog:CLOSe:ALL
driver.display.dialog.close_all_with_opc()

Closes all open dialogs.

Same as close_all, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.

Parameters:

opc_timeout_ms – Maximum time to wait in milliseconds, valid only for this call.

get_id() → str

# DISPlay:DIALog:ID
value: str = driver.display.dialog.get_id()

Returns the dialog identifiers of the open dialogs in a string separated by blanks.

Returns:

dialog_id_list: DialogID#1 DialogID#2 … DialogID#n Dialog identifiers are string without blanks. Blanks are represented as $$. Dialog identifiers DialogID are composed of two main parts: DialogName[OptionalParts] DialogName Meaningful information, mandatory input parameter for the commands: method RsSmw.display.dialog.open() method RsSmw.display.dialog.close() Optional parts String of $X values, where X is a character, interpreted as follows: $qDialogQualifier: optional dialog qualifier, usually the letter A or B, as displayed in the dialog title. $iInstances: comma-separated list of instance indexes, given in the order h,c,s,d,g,u,0. Default is zero; the terminating ‘,0’ can be omitted. $tTabIds: comma-separated indexes or tab names; required, if a dialog is composed of several tabs. $xLeft$yTop$hLeft$wTop: position and size; superfluous information.

open(dialog_id: str) → None

# DISPlay:DIALog:OPEN
driver.display.dialog.open(dialog_id = 'abc')

Opens the specified dialog.

Parameters:

dialog_id – string To find out the dialog identifier, use the query method RsSmw.display.dialog.id() . The DialogName part of the query result is mandatory.