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, range_mode: enums.WindowRangeMode, trigger=repcap.Trigger.Default) -> None:
"""
``TRIGger<*>:WINDow:RANGe`` \n
Snippet: ``driver.trigger.window.range.set(range_mode = enums.WindowRangeMode.ENTer, trigger = repcap.Trigger.Default)`` \n
Defines the signal run in relation to the window:
:param range_mode: ENTer | EXIT | WITHin | OUTSide \n
- ENTer: Triggers when the signal crosses the upper or lower level and thus enters the window made up of these two levels.
- EXIT: Triggers when the signal leaves the window.
- WITHin: Triggers if the signal stays between the upper and lower level for a specified time. The time is defined using the TRIGgert:WINDow:TIME command.
- OUTSide: Triggers if the signal stays above the upper level or below the lower level for a specified time. The time is defined using the TRIGgert:WINDow:TIME command.
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
"""
param = Conversions.enum_scalar_to_str(range_mode, enums.WindowRangeMode)
trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
self._core.io.write_with_opc(f'TRIGger{trigger_cmd_val}:WINDow:RANGe {param}')
# noinspection PyTypeChecker
[docs]
def get(self, trigger=repcap.Trigger.Default) -> enums.WindowRangeMode:
"""
``TRIGger<*>:WINDow:RANGe`` \n
Snippet: ``value: enums.WindowRangeMode = driver.trigger.window.range.get(trigger = repcap.Trigger.Default)`` \n
Defines the signal run in relation to the window:
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
:return: range_mode: ENTer | EXIT | WITHin | OUTSide \n
- ENTer: Triggers when the signal crosses the upper or lower level and thus enters the window made up of these two levels.
- EXIT: Triggers when the signal leaves the window.
- WITHin: Triggers if the signal stays between the upper and lower level for a specified time. The time is defined using the TRIGgert:WINDow:TIME command.
- OUTSide: Triggers if the signal stays above the upper level or below the lower level for a specified time. The time is defined using the TRIGgert:WINDow:TIME command.
"""
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}:WINDow:RANGe?')
return Conversions.str_to_scalar_enum(response, enums.WindowRangeMode)