from ..Internal.Core import Core
from ..Internal.CommandsGroup import CommandsGroup
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class TriggerInvokeCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("triggerInvoke", core, parent)
[docs]
def set(self) -> None:
"""
````*TRG```` \n
Snippet: ``driver.triggerInvoke.set()`` \n
Trigger Triggers all actions waiting for a trigger event. In particular, ``*TRG`` generates a manual trigger signal. This
common command complements the commands of the TRIGger subsystem. ``*TRG`` corresponds to the INITiate:IMMediate command.
See method ``RsFsw.applications.k10Xlte.initiate.immediate.perform()`` .
"""
self._core.io.write(f'*TRG')
[docs]
def set_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
````*TRG```` \n
Snippet: ``driver.triggerInvoke.set_with_opc()`` \n
Trigger Triggers all actions waiting for a trigger event. In particular, ``*TRG`` generates a manual trigger signal. This
common command complements the commands of the TRIGger subsystem. ``*TRG`` corresponds to the INITiate:IMMediate command.
See method ``RsFsw.applications.k10Xlte.initiate.immediate.perform()`` .
Same as set, but waits for the operation to complete before continuing further. Use the RsFsw.utilities.opc_timeout_set() to set the timeout value.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'*TRG', opc_timeout_ms)