Source code for rsrtx.Implementations.Trigger.Pattern.Width.Range

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


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

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

[docs] def set(self, width_range_mode: enums.TriggerSearchRangeMode, trigger=repcap.Trigger.Default) -> None: """ ``TRIGger<*>:PATTern:WIDTh:RANGe`` \n Snippet: ``driver.trigger.pattern.width.range.set(width_range_mode = enums.TriggerSearchRangeMode.LONGer, trigger = repcap.Trigger.Default)`` \n Defines how the range of a pulse width is defined for keeping up the true result of the pattern condition. The width and delta are specified using method ``RsRtx.trigger.pattern.width.width.set()`` and method ``RsRtx.trigger.pattern.width.delta.set()`` , respectively. :param width_range_mode: WITHin | OUTSide | SHORter | LONGer \n - WITHin: Triggers on pulses inside a given range. The range is defined by the width ±delta. - OUTSide: Triggers on pulses outside a given range. The range is defined by the width ±delta. - SHORter: Triggers on pulses shorter than the given width. - LONGer: Triggers on pulses longer than the given width. :param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger') """ param = Conversions.enum_scalar_to_str(width_range_mode, enums.TriggerSearchRangeMode) trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger) self._core.io.write_with_opc(f'TRIGger{trigger_cmd_val}:PATTern:WIDTh:RANGe {param}')
# noinspection PyTypeChecker
[docs] def get(self, trigger=repcap.Trigger.Default) -> enums.TriggerSearchRangeMode: """ ``TRIGger<*>:PATTern:WIDTh:RANGe`` \n Snippet: ``value: enums.TriggerSearchRangeMode = driver.trigger.pattern.width.range.get(trigger = repcap.Trigger.Default)`` \n Defines how the range of a pulse width is defined for keeping up the true result of the pattern condition. The width and delta are specified using method ``RsRtx.trigger.pattern.width.width.set()`` and method ``RsRtx.trigger.pattern.width.delta.set()`` , respectively. :param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger') :return: width_range_mode: WITHin | OUTSide | SHORter | LONGer \n - WITHin: Triggers on pulses inside a given range. The range is defined by the width ±delta. - OUTSide: Triggers on pulses outside a given range. The range is defined by the width ±delta. - SHORter: Triggers on pulses shorter than the given width. - LONGer: Triggers on pulses longer than the given width. """ trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger) response = self._core.io.query_str_with_opc(f'TRIGger{trigger_cmd_val}:PATTern:WIDTh:RANGe?') return Conversions.str_to_scalar_enum(response, enums.TriggerSearchRangeMode)