Source code for rsrtx.Implementations.Bus.Threshold

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


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

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

[docs] def set(self, shw_thres_lines: bool, bus=repcap.Bus.Default) -> None: """ ``BUS<*>:THReshold`` \n Snippet: ``driver.bus.threshold.set(shw_thres_lines = False, bus = repcap.Bus.Default)`` \n If ON, the threshold levels are displayed in the diagram. :param shw_thres_lines: OFF | ON :param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus') """ param = Conversions.bool_to_str(shw_thres_lines) bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus) self._core.io.write_with_opc(f'BUS{bus_cmd_val}:THReshold {param}')
[docs] def get(self, bus=repcap.Bus.Default) -> bool: """ ``BUS<*>:THReshold`` \n Snippet: ``value: bool = driver.bus.threshold.get(bus = repcap.Bus.Default)`` \n If ON, the threshold levels are displayed in the diagram. :param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus') :return: shw_thres_lines: OFF | ON """ bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus) response = self._core.io.query_str_with_opc(f'BUS{bus_cmd_val}:THReshold?') return Conversions.str_to_bool(response)