Source code for rsmxo.Implementations.Export.Hmeasurement.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: 1. header value: start value. For measurement results in the measurement unit, for vertical waveform histogram in the waveform unit, for horizontal waveform histogram in s.
			- 2 End: float: 2. header value: end value, same units as for the start value.
			- 3 Histogram_Length: int: 3. header value: number of histogram bins
		"""
		__meta_args_list = [
			ArgStruct.scalar_float('Start'),
			ArgStruct.scalar_float('End'),
			ArgStruct.scalar_int('Histogram_Length')]

		def __init__(self):
			StructBase.__init__(self, self)
			self.Start: float = None
			self.End: float = None
			self.Histogram_Length: int = None




	def get(self, measIndex=repcap.MeasIndex.Default) -> GetStruct:
		"""
		``EXPort:HMEasurement<*>:DATA:HEADer`` \n
		Snippet: ``value: GetStruct = driver.export.hmeasurement.data.header.get(measIndex = repcap.MeasIndex.Default)`` \n
		Returns the header of the histogram data, the attributes of the waveform histogram or of the histogram on measurement
		results.

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