Source code for RsFsw.Implementations.Applications.K10x_Lte.Output.Trigger.UserDefined.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, outputConnector=repcap.OutputConnector.Default, triggerPort=repcap.TriggerPort.Default) -> None:
		"""
		``OUTPut<up>:TRIGger<tp>[:UDEFined]:PULSe:IMMediate`` \n
		Snippet: ``driver.applications.k10Xlte.output.trigger.userDefined.pulse.immediate.perform(outputConnector = repcap.OutputConnector.Default, triggerPort = repcap.TriggerPort.Default)`` \n
		Generates a pulse at the trigger output.

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




	def perform_with_opc(self, outputConnector=repcap.OutputConnector.Default, triggerPort=repcap.TriggerPort.Default, opc_timeout_ms: int = -1) -> None:
		outputConnector_cmd_val = self._cmd_group.get_repcap_cmd_value(outputConnector, repcap.OutputConnector)
		triggerPort_cmd_val = self._cmd_group.get_repcap_cmd_value(triggerPort, repcap.TriggerPort)
		"""
		``OUTPut<up>:TRIGger<tp>[:UDEFined]:PULSe:IMMediate`` \n
		Snippet: ``driver.applications.k10Xlte.output.trigger.userDefined.pulse.immediate.perform_with_opc(outputConnector = repcap.OutputConnector.Default, 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 outputConnector: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Output')
		: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{outputConnector_cmd_val}:TRIGger{triggerPort_cmd_val}:UDEFined:PULSe:IMMediate', opc_timeout_ms)