Source code for RsFsw.Implementations.Output.Trigger.Pulse.Immediate

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from ..... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ImmediateCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("immediate", core, parent)



	def perform(self, triggerPort=repcap.TriggerPort.Default) -> None:
		"""
		``OUTPut:TRIGger<2 | 3>:PULSe:IMMediate`` \n
		Snippet: ``driver.output.trigger.pulse.immediate.perform(triggerPort = repcap.TriggerPort.Default)`` \n
		Generates a pulse at the trigger output.

		:param triggerPort: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
		"""
		triggerPort_cmd_val = self._cmd_group.get_repcap_cmd_value(triggerPort, repcap.TriggerPort)
		self._core.io.write(f'OUTPut:TRIGger{triggerPort_cmd_val}:PULSe:IMMediate')




	def perform_with_opc(self, triggerPort=repcap.TriggerPort.Default, opc_timeout_ms: int = -1) -> None:
		triggerPort_cmd_val = self._cmd_group.get_repcap_cmd_value(triggerPort, repcap.TriggerPort)
		"""
		``OUTPut:TRIGger<2 | 3>:PULSe:IMMediate`` \n
		Snippet: ``driver.output.trigger.pulse.immediate.perform_with_opc(triggerPort = repcap.TriggerPort.Default)`` \n
		Generates a pulse at the trigger output.

		Same as perform, but waits for the operation to complete before continuing further. Use the RsFsw.utilities.opc_timeout_set() to set the timeout value.

		:param triggerPort: 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.
		"""
		self._core.io.write_with_opc(f'OUTPut:TRIGger{triggerPort_cmd_val}:PULSe:IMMediate', opc_timeout_ms)