Source code for rsmxo.Implementations.P3Phase.Quality.Power.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: start time in s
			- 2 Xstop: float: 2. header value: end time in s
			- 3 Record_Length: int: 3. header value: record length of the waveform in samples
			- 4 Vals_Per_Smp: int: 4. header value: number of values per sample. For 3-phase power quality measurements, the value is 1.
		"""
		__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, power3PhaseMeas=repcap.Power3PhaseMeas.Default, power=repcap.Power.Default) -> GetStruct:
		"""
		``P3PHase<*>:QUALity:POWer<*>:DATA:HEADer`` \n
		Snippet: ``value: GetStruct = driver.p3Phase.quality.power.data.header.get(power3PhaseMeas = repcap.Power3PhaseMeas.Default, power = repcap.Power.Default)`` \n
		Returns the header of the 3-phase power analysis waveform data for the individual phases. The header contains the
		attributes of the waveform. For power harmonics measurements, data is only available if method
		``RsMxo.p3Phase.harmonics.standard.set()`` is set to ENC or END.

		:param power3PhaseMeas: optional repeated capability selector. Default value: Nr1 (settable in the interface 'P3Phase')
		:param power: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Power')
		:return: structure: for return value, see the help for GetStruct structure arguments.
		"""
		power3PhaseMeas_cmd_val = self._cmd_group.get_repcap_cmd_value(power3PhaseMeas, repcap.Power3PhaseMeas)
		power_cmd_val = self._cmd_group.get_repcap_cmd_value(power, repcap.Power)
		return self._core.io.query_struct(f'P3PHase{power3PhaseMeas_cmd_val}:QUALity:POWer{power_cmd_val}:DATA:HEADer?', self.__class__.GetStruct())