Source code for rsmxo.Implementations.Wgenerator.ArbGen.Samples

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


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

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

[docs] def get(self, waveformGen=repcap.WaveformGen.Default) -> int: """ ``WGENerator<*>:ARBGen:SAMPles`` \n Snippet: ``value: int = driver.wgenerator.arbGen.samples.get(waveformGen = repcap.WaveformGen.Default)`` \n Returns the number of samples in the loaded waveform. :param waveformGen: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator') :return: num_samples: 0 to 128E+6 """ waveformGen_cmd_val = self._cmd_group.get_repcap_cmd_value(waveformGen, repcap.WaveformGen) response = self._core.io.query_str(f'WGENerator{waveformGen_cmd_val}:ARBGen:SAMPles?') return Conversions.str_to_int(response)