from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ForceCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("force", core, parent)
[docs]
def set(self, trigger=repcap.Trigger.Default, opc_timeout_ms: int = -1) -> None:
"""
``TRIGger<*>:FORCe`` \n
Snippet: ``driver.trigger.force.set(trigger = repcap.Trigger.Default)`` \n
If the acquisition is running in normal mode and no valid trigger occurs, forcing the trigger provokes an immediate
single acquisition. Thus you can confirm that a signal is available and use the waveform display to determine how to
trigger on it.
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
self._core.io.write_with_opc(f'TRIGger{trigger_cmd_val}:FORCe', opc_timeout_ms)