Source code for rsmxo.Implementations.RefCurve.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 Xstart: float: 1. header value: time of the first sample in s for a time domain signal, or start frequency of the first spectrum bin in Hz for a frequency domain signal
			- 2 Xstop: float: 2. header value: time of the last sample in s for a time domain signal, or start frequency of the last spectrum bin in Hz for a frequency domain signal
			- 3 Record_Length: int: 3. header value: record length of the waveform in samples or bins
			- 4 Vals_Per_Smp: int: 4. header value: number of values per sample or bin. The number depends on the source waveform from which the reference waveform was created.
		"""
		__meta_args_list = [
			ArgStruct.scalar_float('Xstart'),
			ArgStruct.scalar_float('Xstop'),
			ArgStruct.scalar_int('Record_Length'),
			ArgStruct.scalar_int('Vals_Per_Smp')]

		def __init__(self):
			StructBase.__init__(self, self)
			self.Xstart: float = None
			self.Xstop: float = None
			self.Record_Length: int = None
			self.Vals_Per_Smp: int = None




	def get(self, refCurve=repcap.RefCurve.Default) -> GetStruct:
		"""
		``REFCurve<*>:DATA:HEADer`` \n
		Snippet: ``value: GetStruct = driver.refCurve.data.header.get(refCurve = repcap.RefCurve.Default)`` \n
		Returns header information on the reference waveform, the attributes of the waveform.
		The information depends on the waveform domain, it is different for time domain and frequency domain reference waveforms. See: \n
			- method ``RsMxo.channel.data.header.get()``
			- method ``RsMxo.calculate.spectrum.waveform.normal.data.header.get()``

		:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
		:return: structure: for return value, see the help for GetStruct structure arguments.
		"""
		refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
		return self._core.io.query_struct(f'REFCurve{refCurve_cmd_val}:DATA:HEADer?', self.__class__.GetStruct())