Source code for rsmxo.Implementations.HardCopy.Immediate

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


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

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



	def perform(self, opc_timeout_ms: int = -1) -> None:
		"""
		``HCOPy:IMMediate`` \n
		Snippet: ``driver.hardCopy.immediate.perform()`` \n
		Starts the immediate output of the display image, depending on the HCOPy:DESTination<m> destination setting. To define
		the file name, use method ``RsMxo.massMemory.name()`` . Existing files are overwritten by the HCOP:IMMM command. To get a
		correct screenshot of the diagrams, results, and dialog boxes, turn on the display using method
		``RsMxo.system.display.update()`` .

		:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
		"""
		self._core.io.write_with_opc(f'HCOPy:IMMediate', opc_timeout_ms)




	def perform_next(self, opc_timeout_ms: int = -1) -> None:
		"""
		``HCOPy:IMMediate:NEXT`` \n
		Snippet: ``driver.hardCopy.immediate.perform_next()`` \n
		Starts the output of the next display image, depending on the HCOPy:DESTination<m> destination setting. If the screenshot
		is saved to a file, the file name used in the last saving process is automatically counted up to the next unused name. To
		define the file name, use method ``RsMxo.massMemory.name()`` .

		:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
		"""
		self._core.io.write_with_opc(f'HCOPy:IMMediate:NEXT', opc_timeout_ms)