Source code for RsFsw.Implementations.Applications.K60_Transient.Trace.Iq.Data.FormatPy

from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import enums


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FormatPyCls:
	"""FormatPy commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""

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

	def set(self, format_py: enums.IqResultDataFormat) -> None:
		"""SCPI: TRACe:IQ:DATA:FORMat \n
		Snippet: driver.applications.k60Transient.trace.iq.data.formatPy.set(format_py = enums.IqResultDataFormat.COMPatible) \n
		Selects the order of the I/Q data. For details see 'Reference: format description for I/Q data files'.
		For traces captured using the optional 2 GHz / 5 GHz bandwidth extension (FSW-B2000/B5000) , only 'IQPair' format is
		available. \n
			:param format_py: COMPatible | IQBLock | IQPair COMPatible I and Q values are separated and collected in blocks: A block (512k) of I values is followed by a block (512k) of Q values, followed by a block of I values, followed by a block of Q values etc. (I,I,I,I,Q,Q,Q,Q,I,I,I,I,Q,Q,Q,Q...) IQBLock First all I-values are listed, then the Q-values (I,I,I,I,I,I,...Q,Q,Q,Q,Q,Q) This option is not available for input from SnP files (see 'Compensating for Frequency Response Using SnP Files (FSW-K544) ') . IQPair One pair of I/Q values after the other is listed (I,Q,I,Q,I,Q...) . This option is the default for input from SnP files (see 'Compensating for Frequency Response Using SnP Files (FSW-K544) ') .
		"""
		param = Conversions.enum_scalar_to_str(format_py, enums.IqResultDataFormat)
		self._core.io.write(f'TRACe:IQ:DATA:FORMat {param}')

	# noinspection PyTypeChecker
	def get(self) -> enums.IqResultDataFormat:
		"""SCPI: TRACe:IQ:DATA:FORMat \n
		Snippet: value: enums.IqResultDataFormat = driver.applications.k60Transient.trace.iq.data.formatPy.get() \n
		Selects the order of the I/Q data. For details see 'Reference: format description for I/Q data files'.
		For traces captured using the optional 2 GHz / 5 GHz bandwidth extension (FSW-B2000/B5000) , only 'IQPair' format is
		available. \n
			:return: format_py: COMPatible | IQBLock | IQPair COMPatible I and Q values are separated and collected in blocks: A block (512k) of I values is followed by a block (512k) of Q values, followed by a block of I values, followed by a block of Q values etc. (I,I,I,I,Q,Q,Q,Q,I,I,I,I,Q,Q,Q,Q...) IQBLock First all I-values are listed, then the Q-values (I,I,I,I,I,I,...Q,Q,Q,Q,Q,Q) This option is not available for input from SnP files (see 'Compensating for Frequency Response Using SnP Files (FSW-K544) ') . IQPair One pair of I/Q values after the other is listed (I,Q,I,Q,I,Q...) . This option is the default for input from SnP files (see 'Compensating for Frequency Response Using SnP Files (FSW-K544) ') ."""
		response = self._core.io.query_str(f'TRACe:IQ:DATA:FORMat?')
		return Conversions.str_to_scalar_enum(response, enums.IqResultDataFormat)