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 ModeCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("mode", core, parent)
[docs]
def set(self, mode: enums.PatternMode, trigger=repcap.Trigger.Default) -> None:
"""
``TRIGger<*>:PATTern:MODE`` \n
Snippet: ``driver.trigger.pattern.mode.set(mode = enums.PatternMode.OFF, trigger = repcap.Trigger.Default)`` \n
Adds additional time limitation to the pattern definition.
:param mode: OFF | TIMeout | WIDTh \n
- OFF: No time limitation. The event occurs if the pattern condition is fulfilled.
- TIMeout: Defines how long the result of the pattern condition must be true or false. The duration of the timeout is defined using TRIGgert:PATTern:TIMeout[:TIME].
- WIDTh: Defines a time range for keeping up the true result of the pattern condition. The range is defined using TRIGgert:PATTern:WIDTh:RANGe.
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
"""
param = Conversions.enum_scalar_to_str(mode, enums.PatternMode)
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:MODE {param}')
# noinspection PyTypeChecker
[docs]
def get(self, trigger=repcap.Trigger.Default) -> enums.PatternMode:
"""
``TRIGger<*>:PATTern:MODE`` \n
Snippet: ``value: enums.PatternMode = driver.trigger.pattern.mode.get(trigger = repcap.Trigger.Default)`` \n
Adds additional time limitation to the pattern definition.
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
:return: mode: OFF | TIMeout | WIDTh \n
- OFF: No time limitation. The event occurs if the pattern condition is fulfilled.
- TIMeout: Defines how long the result of the pattern condition must be true or false. The duration of the timeout is defined using TRIGgert:PATTern:TIMeout[:TIME].
- WIDTh: Defines a time range for keeping up the true result of the pattern condition. The range is defined using TRIGgert:PATTern:WIDTh:RANGe.
"""
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:MODE?')
return Conversions.str_to_scalar_enum(response, enums.PatternMode)