Source code for rsrtx.Implementations.Channel.Waveform.Data.Header

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal.StructBase import StructBase
from .....Internal.ArgStruct import ArgStruct
from ..... import repcap


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

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

	# noinspection PyTypeChecker


	class GetStruct(StructBase):
		"""
		Response structure. Fields: \n
			- 1 Start: float: No parameter help available
			- 2 Stop: float: No parameter help available
			- 3 Record_Length: int: No parameter help available
			- 4 Vals_Per_Smp: int: No parameter help available
		"""
		__meta_args_list = [
			ArgStruct.scalar_float('Start'),
			ArgStruct.scalar_float('Stop'),
			ArgStruct.scalar_int('Record_Length'),
			ArgStruct.scalar_int('Vals_Per_Smp')]

		def __init__(self):
			StructBase.__init__(self, self)
			self.Start: float = None
			self.Stop: float = None
			self.Record_Length: int = None
			self.Vals_Per_Smp: int = None




	def get(self, channel=repcap.Channel.Default, waveform=repcap.Waveform.Default) -> GetStruct:
		"""
		``CHANnel<*>[:WAVeform<*>]:DATA:HEADer`` \n
		Snippet: ``value: GetStruct = driver.channel.waveform.data.header.get(channel = repcap.Channel.Default, waveform = repcap.Waveform.Default)`` \n
		Returns the header of channel waveform data.
		Position / Meaning / Example \n
			- 1 / XStart in s / 9.477E-008 = - 94,77 ns
			- 2 / XStop in s / 9.477E-008 = 94,77 ns
			- 3 / Record length of one waveform / 200000
			- 4 / Number of values per sample interval. For most waveforms the result is 1, for peak detect and envelope waveforms it is 2. If the number is 2, the number of returned values is twice the number of samples (record length) . / 1

		If multichannel export is enabled, the number of returned samples is Record length * Number of exported waveforms.
		See also method ``RsRtx.export.waveform.multi_channel()`` .

		:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
		:param waveform: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Waveform')
		:return: structure: for return value, see the help for GetStruct structure arguments.
		"""
		channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel)
		waveform_cmd_val = self._cmd_group.get_repcap_cmd_value(waveform, repcap.Waveform)
		return self._core.io.query_struct(f'CHANnel{channel_cmd_val}:WAVeform{waveform_cmd_val}:DATA:HEADer?', self.__class__.GetStruct())