Source code for rsrtx.Implementations.Measurement.Jitter.Clock.FrEstimation

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, measurement=repcap.Measurement.Default) -> None: """ ``MEASurement<*>:JITTer:CLOCk:FREStimation`` \n Snippet: ``driver.measurement.jitter.clock.frEstimation.set(measurement = repcap.Measurement.Default)`` \n Calculates an estimate value for the clock frequency. The setting is relevant if the clock is an explicit clock signal and the data signal has a PAM order > 2. :param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') """ measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement) self._core.io.write(f'MEASurement{measurement_cmd_val}:JITTer:CLOCk:FREStimation')
[docs] def set_and_wait(self, measurement=repcap.Measurement.Default, opc_timeout_ms: int = -1) -> None: measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement) """ ``MEASurement<*>:JITTer:CLOCk:FREStimation`` \n Snippet: ``driver.measurement.jitter.clock.frEstimation.set_and_wait(measurement = repcap.Measurement.Default)`` \n Calculates an estimate value for the clock frequency. The setting is relevant if the clock is an explicit clock signal and the data signal has a PAM order > 2. 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 measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement') :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'MEASurement{measurement_cmd_val}:JITTer:CLOCk:FREStimation', opc_timeout_ms)