Source code for rsrtx.Implementations.Display.ResultBoxes

from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ... import enums


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ResultBoxesCls:
	"""
	| Commands in total: 3
	| Subgroups: 0
	| Direct child commands: 3
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("resultBoxes", core, parent)

	# noinspection PyTypeChecker
[docs] def get_me_position(self) -> enums.DispResultBoxPosition: """ ``DISPlay:RESultboxes:MEPosition`` \n Snippet: ``value: enums.DispResultBoxPosition = driver.display.resultBoxes.get_me_position()`` \n Defines the position of the measurement results on the display. """ response = self._core.io.query_str_with_opc('DISPlay:RESultboxes:MEPosition?') return Conversions.str_to_scalar_enum(response, enums.DispResultBoxPosition)
[docs] def set_me_position(self, grouped_meas_res_dialog_default_posi: enums.DispResultBoxPosition) -> None: """ ``DISPlay:RESultboxes:MEPosition`` \n Snippet: ``driver.display.resultBoxes.set_me_position(grouped_meas_res_dialog_default_posi = enums.DispResultBoxPosition.DOCK)`` \n Defines the position of the measurement results on the display. :param grouped_meas_res_dialog_default_posi: PREV | FLOA | DOCK \n - PREV: Preview: result icon on the signal bar - FLOA: Floating: floating result box in front of the diagrams - DOCK: Docked: fixed tab below the diagrams """ param = Conversions.enum_scalar_to_str(grouped_meas_res_dialog_default_posi, enums.DispResultBoxPosition) self._core.io.write_with_opc(f'DISPlay:RESultboxes:MEPosition {param}')
# noinspection PyTypeChecker
[docs] def get_cu_position(self) -> enums.DispResultBoxPosition: """ ``DISPlay:RESultboxes:CUPosition`` \n Snippet: ``value: enums.DispResultBoxPosition = driver.display.resultBoxes.get_cu_position()`` \n Defines the position of the cursor measurement results on the screen. """ response = self._core.io.query_str_with_opc('DISPlay:RESultboxes:CUPosition?') return Conversions.str_to_scalar_enum(response, enums.DispResultBoxPosition)
[docs] def set_cu_position(self, grouped_cursor_res_dialog_default_posi: enums.DispResultBoxPosition) -> None: """ ``DISPlay:RESultboxes:CUPosition`` \n Snippet: ``driver.display.resultBoxes.set_cu_position(grouped_cursor_res_dialog_default_posi = enums.DispResultBoxPosition.DOCK)`` \n Defines the position of the cursor measurement results on the screen. :param grouped_cursor_res_dialog_default_posi: PREV | FLOA | DOCK \n - PREV: Preview: result icon on the signal bar. - FLOA: Floating result box in front of the diagrams. - DOCK: Docked: fixed tab below the diagrams. """ param = Conversions.enum_scalar_to_str(grouped_cursor_res_dialog_default_posi, enums.DispResultBoxPosition) self._core.io.write_with_opc(f'DISPlay:RESultboxes:CUPosition {param}')
# noinspection PyTypeChecker
[docs] def get_de_position(self) -> enums.DispResultBoxPosition: """ ``DISPlay:RESultboxes:DEPosition`` \n Snippet: ``value: enums.DispResultBoxPosition = driver.display.resultBoxes.get_de_position()`` \n Defines the position of the protocol decode result table on the screen. """ response = self._core.io.query_str_with_opc('DISPlay:RESultboxes:DEPosition?') return Conversions.str_to_scalar_enum(response, enums.DispResultBoxPosition)
[docs] def set_de_position(self, decode_res_dialog_default_posi: enums.DispResultBoxPosition) -> None: """ ``DISPlay:RESultboxes:DEPosition`` \n Snippet: ``driver.display.resultBoxes.set_de_position(decode_res_dialog_default_posi = enums.DispResultBoxPosition.DOCK)`` \n Defines the position of the protocol decode result table on the screen. :param decode_res_dialog_default_posi: PREV | FLOA | DOCK \n - PREV: Preview: result icon on the sidebar. - FLOA: Floating result box in front of the diagrams. - DOCK: Docked: fixed tab below the diagrams. """ param = Conversions.enum_scalar_to_str(decode_res_dialog_default_posi, enums.DispResultBoxPosition) self._core.io.write_with_opc(f'DISPlay:RESultboxes:DEPosition {param}')