Source code for rsrtx.Implementations.Zvc.Z.Icurrent.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, zvcProbe=repcap.ZvcProbe.Default, zvcChannel=repcap.ZvcChannel.Default) -> GetStruct:
		"""
		``ZVC:Z<*>:I<*>:DATA:HEADer`` \n
		Snippet: ``value: GetStruct = driver.zvc.z.icurrent.data.header.get(zvcProbe = repcap.ZvcProbe.Default, zvcChannel = repcap.ZvcChannel.Default)`` \n
		Return the header of amperemeter and voltmeter waveform data.
		Position / Meaning / Example \n
			- 1 / Start time in s / 0.0001
			- 2 / Stop time in s / 0.0001
			- 3 / Number of values in one waveform (record length) / 1000
			- 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 values (record length) .. / 1

		:param zvcProbe: optional repeated capability selector. Default value: Ix1 (settable in the interface 'Z')
		:param zvcChannel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Icurrent')
		:return: structure: for return value, see the help for GetStruct structure arguments.
		"""
		zvcProbe_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcProbe, repcap.ZvcProbe)
		zvcChannel_cmd_val = self._cmd_group.get_repcap_cmd_value(zvcChannel, repcap.ZvcChannel)
		return self._core.io.query_struct(f'ZVC:Z{zvcProbe_cmd_val}:I{zvcChannel_cmd_val}:DATA:HEADer?', self.__class__.GetStruct())