Source code for RsSmw.Implementations.Output.User.Trigger.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, userIx=repcap.UserIx.Default) -> None:
		"""
		``OUTPut<HW>:USER<CH>:TRIGger:[IMMediate]`` \n
		Snippet: ``driver.output.user.trigger.immediate.perform(userIx = repcap.UserIx.Default)`` \n
		Generates a short pulse signal and outputs it at the USER connector. This signal can serve as a common external trigger
		signal for triggering of several R&S SMW200A, see Example 'Triggering several R&S SMW200A instruments simultaneously'.

		:param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
		"""
		userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx)
		self._core.io.write(f'OUTPut<HwInstance>:USER{userIx_cmd_val}:TRIGger:IMMediate')




	def perform_with_opc(self, userIx=repcap.UserIx.Default, opc_timeout_ms: int = -1) -> None:
		userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx)
		"""
		``OUTPut<HW>:USER<CH>:TRIGger:[IMMediate]`` \n
		Snippet: ``driver.output.user.trigger.immediate.perform_with_opc(userIx = repcap.UserIx.Default)`` \n
		Generates a short pulse signal and outputs it at the USER connector. This signal can serve as a common external trigger
		signal for triggering of several R&S SMW200A, see Example 'Triggering several R&S SMW200A instruments simultaneously'.

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

		:param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
		:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
		"""
		self._core.io.write_with_opc(f'OUTPut<HwInstance>:USER{userIx_cmd_val}:TRIGger:IMMediate', opc_timeout_ms)