from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StopCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("stop", core, parent)
[docs]
def set(self, relative_stop: float, measIndex=repcap.MeasIndex.Default) -> None:
"""
``MEASurement<*>:EYE:RELative:STOP`` \n
Snippet: ``driver.measurement.eye.relative.stop.set(relative_stop = 1.0, measIndex = repcap.MeasIndex.Default)`` \n
Sets the relative stop value for the selected algorithm of eye height and eye width measurements. For rise time and fall
time eye measurements, the command sets the offset after the first eye crossing (local stop level) . Only values inside
the specified horizontal range are considered for the measurements.
:param relative_stop: The value refers to one unit interval for rise and fall time measurements. For eye width, the value refers to the eye top and base levels. For eye height, the value refers to the eye crossings.
:param measIndex: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
"""
param = Conversions.decimal_value_to_str(relative_stop)
measIndex_cmd_val = self._cmd_group.get_repcap_cmd_value(measIndex, repcap.MeasIndex)
self._core.io.write(f'MEASurement{measIndex_cmd_val}:EYE:RELative:STOP {param}')
[docs]
def get(self, measIndex=repcap.MeasIndex.Default) -> float:
"""
``MEASurement<*>:EYE:RELative:STOP`` \n
Snippet: ``value: float = driver.measurement.eye.relative.stop.get(measIndex = repcap.MeasIndex.Default)`` \n
Sets the relative stop value for the selected algorithm of eye height and eye width measurements. For rise time and fall
time eye measurements, the command sets the offset after the first eye crossing (local stop level) . Only values inside
the specified horizontal range are considered for the measurements.
:param measIndex: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:return: relative_stop: The value refers to one unit interval for rise and fall time measurements. For eye width, the value refers to the eye top and base levels. For eye height, the value refers to the eye crossings.
"""
measIndex_cmd_val = self._cmd_group.get_repcap_cmd_value(measIndex, repcap.MeasIndex)
response = self._core.io.query_str(f'MEASurement{measIndex_cmd_val}:EYE:RELative:STOP?')
return Conversions.str_to_float(response)