Source code for rsmxo.Implementations.Eye.Qualify.Gate

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


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

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

[docs] def set(self, gate: float, eye=repcap.Eye.Default) -> None: """ ``EYE<*>:QUALify:GATE`` \n Snippet: ``driver.eye.qualify.gate.set(gate = 1.0, eye = repcap.Eye.Default)`` \n Selects the gate, which restricts the contributing slices in horizontal direction. Only the timestamps within the defined horizontal interval qualify for eye generation. Enable and configure a gate before you assign it (method ``RsMxo.gate.enable.set()`` =ON) . The query returns 0, if no gate is assigned. :param gate: Number of the gate to be used :param eye: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Eye') """ param = Conversions.decimal_value_to_str(gate) eye_cmd_val = self._cmd_group.get_repcap_cmd_value(eye, repcap.Eye) self._core.io.write(f'EYE{eye_cmd_val}:QUALify:GATE {param}')
[docs] def get(self, eye=repcap.Eye.Default) -> float: """ ``EYE<*>:QUALify:GATE`` \n Snippet: ``value: float = driver.eye.qualify.gate.get(eye = repcap.Eye.Default)`` \n Selects the gate, which restricts the contributing slices in horizontal direction. Only the timestamps within the defined horizontal interval qualify for eye generation. Enable and configure a gate before you assign it (method ``RsMxo.gate.enable.set()`` =ON) . The query returns 0, if no gate is assigned. :param eye: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Eye') :return: gate: Number of the gate to be used """ eye_cmd_val = self._cmd_group.get_repcap_cmd_value(eye, repcap.Eye) response = self._core.io.query_str(f'EYE{eye_cmd_val}:QUALify:GATE?') return Conversions.str_to_float(response)