Source code for rsmxo.Implementations.Probe.Setup.Offset.TopMeter

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


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

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

[docs] def set(self, probe=repcap.Probe.Default) -> None: """ ``PROBe<*>:SETup:OFFSet:TOPMeter`` \n Snippet: ``driver.probe.setup.offset.topMeter.set(probe = repcap.Probe.Default)`` \n Sets the measured R&S ProbeMeter value as offset. Thus, the value is considered in measurements. :param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Probe') """ probe_cmd_val = self._cmd_group.get_repcap_cmd_value(probe, repcap.Probe) self._core.io.write(f'PROBe{probe_cmd_val}:SETup:OFFSet:TOPMeter')
[docs] def set_and_wait(self, probe=repcap.Probe.Default, opc_timeout_ms: int = -1) -> None: probe_cmd_val = self._cmd_group.get_repcap_cmd_value(probe, repcap.Probe) """ ``PROBe<*>:SETup:OFFSet:TOPMeter`` \n Snippet: ``driver.probe.setup.offset.topMeter.set_and_wait(probe = repcap.Probe.Default)`` \n Sets the measured R&S ProbeMeter value as offset. Thus, the value is considered in measurements. 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 probe: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Probe') :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'PROBe{probe_cmd_val}:SETup:OFFSet:TOPMeter', opc_timeout_ms)