Source code for RsFsw.Implementations.Applications.K17_Mcgd.Initiate.Immediate

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


# 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) -> None:
		"""
		``INITiate[:IMMediate]`` \n
		Snippet: ``driver.applications.k17Mcgd.initiate.immediate.perform()`` \n
		Starts a (single) new measurement. With sweep count or average count > 0, this means a restart of the corresponding
		number of measurements. With trace mode MAXHold, MINHold and AVERage, the previous results are reset on restarting the
		measurement. You can synchronize to the end of the measurement with ``*OPC``, ``*OPC?`` or ``*WAI``. For details on
		synchronization see .

		"""
		self._core.io.write(f'INITiate:IMMediate')




	def perform_with_opc(self, opc_timeout_ms: int = -1) -> None:
		"""
		``INITiate[:IMMediate]`` \n
		Snippet: ``driver.applications.k17Mcgd.initiate.immediate.perform_with_opc()`` \n
		Starts a (single) new measurement. With sweep count or average count > 0, this means a restart of the corresponding
		number of measurements. With trace mode MAXHold, MINHold and AVERage, the previous results are reset on restarting the
		measurement. You can synchronize to the end of the measurement with ``*OPC``, ``*OPC?`` or ``*WAI``. For details on
		synchronization see .

		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 opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
		"""
		self._core.io.write_with_opc(f'INITiate:IMMediate', opc_timeout_ms)