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

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Types import DataType
from .....Internal.ArgSingleList import ArgSingleList
from .....Internal.ArgSingle import ArgSingle
from ..... import enums


# 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, search: str, range_mode: enums.TriggerSearchRangeMode) -> None: """ ``SEARch:TRIGger:WIDTh:RANGe`` \n Snippet: ``driver.search.trigger.width.range.set(search = 'abc', range_mode = enums.TriggerSearchRangeMode.LONGer)`` \n Selects how the range of a pulse width is defined in relation to the width and delta (see method ``RsRtx.search.trigger.width.width.set()`` and method ``RsRtx.search.trigger.width.delta.set()`` ) . :param search: Search definition :param range_mode: WITHin | OUTSide | SHORter | LONGer \n - WITHin: Triggers on pulses inside a given range. The range of the pulse width is defined by Width and ±Delta. - OUTSide: Triggers on pulses outside a given range. The range definition is the same as for Within range. - SHORter: Triggers on pulses shorter than the given Width. - LONGer: Triggers on pulses longer than the given Width. """ param = ArgSingleList().compose_cmd_string(ArgSingle('search', search, DataType.String), ArgSingle('range_mode', range_mode, DataType.Enum, enums.TriggerSearchRangeMode)) self._core.io.write_with_opc(f'SEARch:TRIGger:WIDTh:RANGe {param}'.rstrip())
# noinspection PyTypeChecker
[docs] def get(self, search: str) -> enums.TriggerSearchRangeMode: """ ``SEARch:TRIGger:WIDTh:RANGe`` \n Snippet: ``value: enums.TriggerSearchRangeMode = driver.search.trigger.width.range.get(search = 'abc')`` \n Selects how the range of a pulse width is defined in relation to the width and delta (see method ``RsRtx.search.trigger.width.width.set()`` and method ``RsRtx.search.trigger.width.delta.set()`` ) . :param search: Search definition :return: range_mode: WITHin | OUTSide | SHORter | LONGer \n - WITHin: Triggers on pulses inside a given range. The range of the pulse width is defined by Width and ±Delta. - OUTSide: Triggers on pulses outside a given range. The range definition is the same as for Within range. - SHORter: Triggers on pulses shorter than the given Width. - LONGer: Triggers on pulses longer than the given Width. """ param = Conversions.value_to_quoted_str(search) response = self._core.io.query_str_with_opc(f'SEARch:TRIGger:WIDTh:RANGe? {param}') return Conversions.str_to_scalar_enum(response, enums.TriggerSearchRangeMode)