Source code for rsrtx.Implementations.Wgenerator.ArbGen

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ArbGenCls:
	"""
	| Commands in total: 12
	| Subgroups: 8
	| Direct child commands: 2
	"""

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

	@property
	def source(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_source'):
			from .Source import SourceCls
			self._source = SourceCls(self._core, self._cmd_group)
		return self._source

	@property
	def runMode(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_runMode'):
			from .RunMode import RunModeCls
			self._runMode = RunModeCls(self._core, self._cmd_group)
		return self._runMode

	@property
	def select(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_select'):
			from .Select import SelectCls
			self._select = SelectCls(self._core, self._cmd_group)
		return self._select

	@property
	def symbolRate(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_symbolRate'):
			from .SymbolRate import SymbolRateCls
			self._symbolRate = SymbolRateCls(self._core, self._cmd_group)
		return self._symbolRate

	@property
	def samples(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_samples'):
			from .Samples import SamplesCls
			self._samples = SamplesCls(self._core, self._cmd_group)
		return self._samples

	@property
	def name(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_name'):
			from .Name import NameCls
			self._name = NameCls(self._core, self._cmd_group)
		return self._name

	@property
	def runSingle(self):
		"""
		| Commands in total: 1
		| Subgroups: 0
		| Direct child commands: 1
		"""
		if not hasattr(self, '_runSingle'):
			from .RunSingle import RunSingleCls
			self._runSingle = RunSingleCls(self._core, self._cmd_group)
		return self._runSingle

	@property
	def multiChannel(self):
		"""
		| Commands in total: 3
		| Subgroups: 2
		| Direct child commands: 1
		"""
		if not hasattr(self, '_multiChannel'):
			from .MultiChannel import MultiChannelCls
			self._multiChannel = MultiChannelCls(self._core, self._cmd_group)
		return self._multiChannel

[docs] def copy(self, wgenerator=repcap.Wgenerator.Default) -> None: """ ``WGENerator<*>:ARBGen:COPY`` \n Snippet: ``driver.wgenerator.arbGen.copy(wgenerator = repcap.Wgenerator.Default)`` \n Loads the waveform from the selected signal source (method ``RsRtx.wgenerator.arbGen.select.set()`` ) . :param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') """ wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator) self._core.io.write(f'WGENerator{wgenerator_cmd_val}:ARBGen:COPY')
[docs] def copy_and_wait(self, wgenerator=repcap.Wgenerator.Default, opc_timeout_ms: int = -1) -> None: wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator) """ ``WGENerator<*>:ARBGen:COPY`` \n Snippet: ``driver.wgenerator.arbGen.copy_and_wait(wgenerator = repcap.Wgenerator.Default)`` \n Loads the waveform from the selected signal source (method ``RsRtx.wgenerator.arbGen.select.set()`` ) . Same as copy, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value. :param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'WGENerator{wgenerator_cmd_val}:ARBGen:COPY', opc_timeout_ms)
[docs] def open(self, wgenerator=repcap.Wgenerator.Default) -> None: """ ``WGENerator<*>:ARBGen:OPEN`` \n Snippet: ``driver.wgenerator.arbGen.open(wgenerator = repcap.Wgenerator.Default)`` \n Loads the arbitrary waveform, that is selected with the method ``RsRtx.wgenerator.arbGen.name.set()`` command. This command is only relevant for files with one waveform defined. For multichannel arbitrary waveform files, see method ``RsRtx.wgenerator.arbGen.multiChannel.open()`` . :param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') """ wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator) self._core.io.write(f'WGENerator{wgenerator_cmd_val}:ARBGen:OPEN')
[docs] def open_and_wait(self, wgenerator=repcap.Wgenerator.Default, opc_timeout_ms: int = -1) -> None: wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator) """ ``WGENerator<*>:ARBGen:OPEN`` \n Snippet: ``driver.wgenerator.arbGen.open_and_wait(wgenerator = repcap.Wgenerator.Default)`` \n Loads the arbitrary waveform, that is selected with the method ``RsRtx.wgenerator.arbGen.name.set()`` command. This command is only relevant for files with one waveform defined. For multichannel arbitrary waveform files, see method ``RsRtx.wgenerator.arbGen.multiChannel.open()`` . Same as open, but waits for the operation to complete before continuing further. Use the RsRtx.utilities.opc_timeout_set() to set the timeout value. :param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') :param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call. """ self._core.io.write_with_opc(f'WGENerator{wgenerator_cmd_val}:ARBGen:OPEN', opc_timeout_ms)
def clone(self) -> 'ArbGenCls': """ 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 = ArbGenCls(self._core, self._cmd_group.parent) self._cmd_group.synchronize_repcaps(new_group) return new_group