Source code for rsrtx.Implementations.Eye.Display.Mode

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


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

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

[docs] def set(self, eye_stripe_mode: enums.EyeStripeMode, eye=repcap.Eye.Default) -> None: """ ``EYE<*>:DISPlay:MODE`` \n Snippet: ``driver.eye.display.mode.set(eye_stripe_mode = enums.EyeStripeMode.ALWays, eye = repcap.Eye.Default)`` \n Defines when the eye stripe is shown: always, never, or during mask tests. :param eye_stripe_mode: MTONly: Mask test only :param eye: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Eye') """ param = Conversions.enum_scalar_to_str(eye_stripe_mode, enums.EyeStripeMode) eye_cmd_val = self._cmd_group.get_repcap_cmd_value(eye, repcap.Eye) self._core.io.write_with_opc(f'EYE{eye_cmd_val}:DISPlay:MODE {param}')
# noinspection PyTypeChecker
[docs] def get(self, eye=repcap.Eye.Default) -> enums.EyeStripeMode: """ ``EYE<*>:DISPlay:MODE`` \n Snippet: ``value: enums.EyeStripeMode = driver.eye.display.mode.get(eye = repcap.Eye.Default)`` \n Defines when the eye stripe is shown: always, never, or during mask tests. :param eye: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Eye') :return: eye_stripe_mode: MTONly: Mask test only """ eye_cmd_val = self._cmd_group.get_repcap_cmd_value(eye, repcap.Eye) response = self._core.io.query_str_with_opc(f'EYE{eye_cmd_val}:DISPlay:MODE?') return Conversions.str_to_scalar_enum(response, enums.EyeStripeMode)