Source code for rsmxo.Implementations.Treference.Cdr.Software.SrEstimate

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


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

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

[docs] def set(self, timingReference=repcap.TimingReference.Default) -> None: """ ``TREFerence<*>:CDR:SOFTware:SREStimate`` \n Snippet: ``driver.treference.cdr.software.srEstimate.set(timingReference = repcap.TimingReference.Default)`` \n Starts a software algorithm to detect the symbol rate for the selected source automatically. :param timingReference: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Treference') """ timingReference_cmd_val = self._cmd_group.get_repcap_cmd_value(timingReference, repcap.TimingReference) self._core.io.write(f'TREFerence{timingReference_cmd_val}:CDR:SOFTware:SREStimate')
[docs] def set_and_wait(self, timingReference=repcap.TimingReference.Default, opc_timeout_ms: int = -1) -> None: timingReference_cmd_val = self._cmd_group.get_repcap_cmd_value(timingReference, repcap.TimingReference) """ ``TREFerence<*>:CDR:SOFTware:SREStimate`` \n Snippet: ``driver.treference.cdr.software.srEstimate.set_and_wait(timingReference = repcap.TimingReference.Default)`` \n Starts a software algorithm to detect the symbol rate for the selected source automatically. Same as set, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value. :param timingReference: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Treference') :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'TREFerence{timingReference_cmd_val}:CDR:SOFTware:SREStimate', opc_timeout_ms)