from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FrEstimationCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("frEstimation", core, parent)
[docs]
def set(self, eye=repcap.Eye.Default) -> None:
"""
``EYE<*>:TIMReference:CLOCk:FREStimation`` \n
Snippet: ``driver.eye.timReference.clock.frEstimation.set(eye = repcap.Eye.Default)`` \n
Executes an estimation of the signal for the clock frequency. Available if method ``RsRtx.eye.timReference.source.set()``
is set to CLOCk.
:param eye: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Eye')
"""
eye_cmd_val = self._cmd_group.get_repcap_cmd_value(eye, repcap.Eye)
self._core.io.write(f'EYE{eye_cmd_val}:TIMReference:CLOCk:FREStimation')
[docs]
def set_and_wait(self, eye=repcap.Eye.Default, opc_timeout_ms: int = -1) -> None:
eye_cmd_val = self._cmd_group.get_repcap_cmd_value(eye, repcap.Eye)
"""
``EYE<*>:TIMReference:CLOCk:FREStimation`` \n
Snippet: ``driver.eye.timReference.clock.frEstimation.set_and_wait(eye = repcap.Eye.Default)`` \n
Executes an estimation of the signal for the clock frequency. Available if method ``RsRtx.eye.timReference.source.set()``
is set to CLOCk.
Same as set, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value.
:param eye: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Eye')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'EYE{eye_cmd_val}:TIMReference:CLOCk:FREStimation', opc_timeout_ms)