Source code for rsmxo.Implementations.RefCurve.Restore

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


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

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

[docs] def set(self, refCurve=repcap.RefCurve.Default) -> None: """ ``REFCurve<*>:RESTore`` \n Snippet: ``driver.refCurve.restore.set(refCurve = repcap.RefCurve.Default)`` \n Applies the original settings of the reference waveform to the horizontal and vertical settings of the selected waveform. :param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve') """ refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve) self._core.io.write(f'REFCurve{refCurve_cmd_val}:RESTore')
[docs] def set_and_wait(self, refCurve=repcap.RefCurve.Default, opc_timeout_ms: int = -1) -> None: refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve) """ ``REFCurve<*>:RESTore`` \n Snippet: ``driver.refCurve.restore.set_and_wait(refCurve = repcap.RefCurve.Default)`` \n Applies the original settings of the reference waveform to the horizontal and vertical settings of the selected waveform. 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 refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve') :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'REFCurve{refCurve_cmd_val}:RESTore', opc_timeout_ms)