from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal.Types import DataType
from ........Internal.StructBase import StructBase
from ........Internal.ArgStruct import ArgStruct
from ........Internal.ArgSingleList import ArgSingleList
from ........Internal.ArgSingle import ArgSingle
from ........ import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class ThDistortionCls:
"""ThDistortion commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("thDistortion", core, parent)
[docs] def set(self, enable: bool, upper: float, audioInput=repcap.AudioInput.Default) -> None:
"""SCPI: CONFigure:AFRF:MEASurement<Instance>:MEValuation:LIMit:AIN<Nr>:THDistortion \n
Snippet: driver.configure.afRf.measurement.multiEval.limit.audioInput.thDistortion.set(enable = False, upper = 1.0, audioInput = repcap.AudioInput.Default) \n
Configures a limit for the THD results, measured via an AF input path. \n
:param enable: OFF | ON Enables or disables the limit check
:param upper: Upper THD limit Range: 0 % to 100 %, Unit: %
:param audioInput: optional repeated capability selector. Default value: Nr1 (settable in the interface 'AudioInput')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('enable', enable, DataType.Boolean), ArgSingle('upper', upper, DataType.Float))
audioInput_cmd_val = self._cmd_group.get_repcap_cmd_value(audioInput, repcap.AudioInput)
self._core.io.write(f'CONFigure:AFRF:MEASurement<Instance>:MEValuation:LIMit:AIN{audioInput_cmd_val}:THDistortion {param}'.rstrip())
# noinspection PyTypeChecker
[docs] class ThDistortionStruct(StructBase):
"""Response structure. Fields: \n
- Enable: bool: OFF | ON Enables or disables the limit check
- Upper: float: Upper THD limit Range: 0 % to 100 %, Unit: %"""
__meta_args_list = [
ArgStruct.scalar_bool('Enable'),
ArgStruct.scalar_float('Upper')]
def __init__(self):
StructBase.__init__(self, self)
self.Enable: bool = None
self.Upper: float = None
[docs] def get(self, audioInput=repcap.AudioInput.Default) -> ThDistortionStruct:
"""SCPI: CONFigure:AFRF:MEASurement<Instance>:MEValuation:LIMit:AIN<Nr>:THDistortion \n
Snippet: value: ThDistortionStruct = driver.configure.afRf.measurement.multiEval.limit.audioInput.thDistortion.get(audioInput = repcap.AudioInput.Default) \n
Configures a limit for the THD results, measured via an AF input path. \n
:param audioInput: optional repeated capability selector. Default value: Nr1 (settable in the interface 'AudioInput')
:return: structure: for return value, see the help for ThDistortionStruct structure arguments."""
audioInput_cmd_val = self._cmd_group.get_repcap_cmd_value(audioInput, repcap.AudioInput)
return self._core.io.query_struct(f'CONFigure:AFRF:MEASurement<Instance>:MEValuation:LIMit:AIN{audioInput_cmd_val}:THDistortion?', self.__class__.ThDistortionStruct())