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