Source code for rsmxo.Implementations.Layout.Zoom.Enable

from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap


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

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

[docs] def set(self, state: bool, layout=repcap.Layout.Default, zoom=repcap.Zoom.Default) -> None: """ ``LAYout<*>:ZOOM<*>[:ENABle]`` \n Snippet: ``driver.layout.zoom.enable.set(state = False, layout = repcap.Layout.Default, zoom = repcap.Zoom.Default)`` \n Enables the zoom. :param state: OFF | ON :param layout: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Layout') :param zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Zoom') """ param = Conversions.bool_to_str(state) layout_cmd_val = self._cmd_group.get_repcap_cmd_value(layout, repcap.Layout) zoom_cmd_val = self._cmd_group.get_repcap_cmd_value(zoom, repcap.Zoom) self._core.io.write(f'LAYout{layout_cmd_val}:ZOOM{zoom_cmd_val}:ENABle {param}')
[docs] def get(self, layout=repcap.Layout.Default, zoom=repcap.Zoom.Default) -> bool: """ ``LAYout<*>:ZOOM<*>[:ENABle]`` \n Snippet: ``value: bool = driver.layout.zoom.enable.get(layout = repcap.Layout.Default, zoom = repcap.Zoom.Default)`` \n Enables the zoom. :param layout: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Layout') :param zoom: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Zoom') :return: state: OFF | ON """ layout_cmd_val = self._cmd_group.get_repcap_cmd_value(layout, repcap.Layout) zoom_cmd_val = self._cmd_group.get_repcap_cmd_value(zoom, repcap.Zoom) response = self._core.io.query_str(f'LAYout{layout_cmd_val}:ZOOM{zoom_cmd_val}:ENABle?') return Conversions.str_to_bool(response)