Source code for rsrtx.Implementations.Generator.Alignment.Dc

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DcCls:
	"""
	| Commands in total: 5
	| Subgroups: 1
	| Direct child commands: 2
	"""

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

	@property
	def result(self):
		"""
		| Commands in total: 3
		| Subgroups: 0
		| Direct child commands: 3
		"""
		if not hasattr(self, '_result'):
			from .Result import ResultCls
			self._result = ResultCls(self._core, self._cmd_group)
		return self._result

[docs] def start(self) -> None: """ ``GENerator:ALIGnment:DC[:STARt]`` \n Snippet: ``driver.generator.alignment.dc.start()`` \n Starts a DC offset alignment. """ self._core.io.write(f'GENerator:ALIGnment:DC:STARt')
[docs] def start_and_wait(self, opc_timeout_ms: int = -1) -> None: """ ``GENerator:ALIGnment:DC[:STARt]`` \n Snippet: ``driver.generator.alignment.dc.start_and_wait()`` \n Starts a DC offset alignment. Same as start, but waits for the operation to complete before continuing further. Use the RsRtx.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'GENerator:ALIGnment:DC:STARt', opc_timeout_ms)
[docs] def abort(self) -> None: """ ``GENerator:ALIGnment:DC:ABORt`` \n Snippet: ``driver.generator.alignment.dc.abort()`` \n Aborts a DC offset alignment. """ self._core.io.write(f'GENerator:ALIGnment:DC:ABORt')
[docs] def abort_and_wait(self, opc_timeout_ms: int = -1) -> None: """ ``GENerator:ALIGnment:DC:ABORt`` \n Snippet: ``driver.generator.alignment.dc.abort_and_wait()`` \n Aborts a DC offset alignment. Same as abort, but waits for the operation to complete before continuing further. Use the RsRtx.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'GENerator:ALIGnment:DC:ABORt', opc_timeout_ms)
def clone(self) -> 'DcCls': """ Clones the group by creating new object from it and its whole existing subgroups. Also copies all the existing default Repeated Capabilities setting, which you can change independently without affecting the original group. """ new_group = DcCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group