from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal.StructBase import StructBase
from ........Internal.ArgStruct import ArgStruct
from ........ import enums
from ........ import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CurrentCls:
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("current", core, parent)
# noinspection PyTypeChecker
[docs]
class ResultData(StructBase):
"""
Response structure. Fields: \n
- 1 Reliability: int: 'Reliability indicator'
- 2 Out_Of_Tolerance: int: Out of tolerance result, i.e. the percentage of measurement intervals of the statistic count for modulation measurements exceeding the specified modulation limits.
- 3 Evm_Low: float: EVM PSCCH value, low EVM window position
- 4 Evm_High: float: EVM PSCCH value, high EVM window position
- 5 Mag_Err_Low: float: Magnitude error PSCCH value, low EVM window position
- 6 Mag_Err_High: float: Magnitude error PSCCH value, high EVM window position
- 7 Ph_Error_Low: float: Phase error PSCCH value, low EVM window position
- 8 Ph_Error_High: float: Phase error PSCCH value, high EVM window position
"""
__meta_args_list = [
ArgStruct.scalar_int('Reliability', 'Reliability'),
ArgStruct.scalar_int('Out_Of_Tolerance'),
ArgStruct.scalar_float('Evm_Low'),
ArgStruct.scalar_float('Evm_High'),
ArgStruct.scalar_float('Mag_Err_Low'),
ArgStruct.scalar_float('Mag_Err_High'),
ArgStruct.scalar_float('Ph_Error_Low'),
ArgStruct.scalar_float('Ph_Error_High')]
def __init__(self):
StructBase.__init__(self, self)
self.Reliability: int = None
self.Out_Of_Tolerance: int = None
self.Evm_Low: float = None
self.Evm_High: float = None
self.Mag_Err_Low: float = None
self.Mag_Err_High: float = None
self.Ph_Error_Low: float = None
self.Ph_Error_High: float = None
[docs]
def fetch(self, carrierComponent=repcap.CarrierComponent.Default, layer=repcap.Layer.Default) -> ResultData:
"""
``FETCh:NRSub:MEASurement<Instance>:MEValuation[:CC<no>][:LAYer<layer>]:MODulation:PSCCh:CURRent`` \n
Snippet: ``value: ResultData = driver.nrSubMeas.multiEval.cc.layer.modulation.pscch.current.fetch(carrierComponent = repcap.CarrierComponent.Default, layer = repcap.Layer.Default)`` \n
Return the current, average, extreme and standard deviation single-value PSCCH results for carrier <no>, layer/antenna
<l>. The values described below are returned by FETCh and READ commands. A CALCulate command returns limit check results
instead, one value for each result listed below.
:param carrierComponent: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cc')
:param layer: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Layer')
:return: structure: for return value, see the help for ResultData structure arguments.
"""
carrierComponent_cmd_val = self._cmd_group.get_repcap_cmd_value(carrierComponent, repcap.CarrierComponent)
layer_cmd_val = self._cmd_group.get_repcap_cmd_value(layer, repcap.Layer)
return self._core.io.query_struct(f'FETCh:NRSub:MEASurement<Instance>:MEValuation:CC{carrierComponent_cmd_val}:LAYer{layer_cmd_val}:MODulation:PSCCh:CURRent?', self.__class__.ResultData())
[docs]
def read(self, carrierComponent=repcap.CarrierComponent.Default, layer=repcap.Layer.Default) -> ResultData:
"""
``READ:NRSub:MEASurement<Instance>:MEValuation[:CC<no>][:LAYer<layer>]:MODulation:PSCCh:CURRent`` \n
Snippet: ``value: ResultData = driver.nrSubMeas.multiEval.cc.layer.modulation.pscch.current.read(carrierComponent = repcap.CarrierComponent.Default, layer = repcap.Layer.Default)`` \n
Return the current, average, extreme and standard deviation single-value PSCCH results for carrier <no>, layer/antenna
<l>. The values described below are returned by FETCh and READ commands. A CALCulate command returns limit check results
instead, one value for each result listed below.
:param carrierComponent: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cc')
:param layer: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Layer')
:return: structure: for return value, see the help for ResultData structure arguments.
"""
carrierComponent_cmd_val = self._cmd_group.get_repcap_cmd_value(carrierComponent, repcap.CarrierComponent)
layer_cmd_val = self._cmd_group.get_repcap_cmd_value(layer, repcap.Layer)
return self._core.io.query_struct(f'READ:NRSub:MEASurement<Instance>:MEValuation:CC{carrierComponent_cmd_val}:LAYer{layer_cmd_val}:MODulation:PSCCh:CURRent?', self.__class__.ResultData())
# noinspection PyTypeChecker
[docs]
class CalculateStruct(StructBase):
"""
Response structure. Fields: \n
- 1 Reliability: int: 'Reliability indicator'
- 2 Out_Of_Tolerance: int: Out of tolerance result, i.e. the percentage of measurement intervals of the statistic count for modulation measurements exceeding the specified modulation limits.
- 3 Evm_Low: enums.ResultStatus2: EVM PSCCH value, low EVM window position
- 4 Evm_High: enums.ResultStatus2: EVM PSCCH value, high EVM window position
- 5 Mag_Err_Low: enums.ResultStatus2: Magnitude error PSCCH value, low EVM window position
- 6 Mag_Err_High: enums.ResultStatus2: Magnitude error PSCCH value, high EVM window position
- 7 Ph_Error_Low: enums.ResultStatus2: Phase error PSCCH value, low EVM window position
- 8 Ph_Error_High: enums.ResultStatus2: Phase error PSCCH value, high EVM window position
"""
__meta_args_list = [
ArgStruct.scalar_int('Reliability', 'Reliability'),
ArgStruct.scalar_int('Out_Of_Tolerance'),
ArgStruct.scalar_enum('Evm_Low', enums.ResultStatus2),
ArgStruct.scalar_enum('Evm_High', enums.ResultStatus2),
ArgStruct.scalar_enum('Mag_Err_Low', enums.ResultStatus2),
ArgStruct.scalar_enum('Mag_Err_High', enums.ResultStatus2),
ArgStruct.scalar_enum('Ph_Error_Low', enums.ResultStatus2),
ArgStruct.scalar_enum('Ph_Error_High', enums.ResultStatus2)]
def __init__(self):
StructBase.__init__(self, self)
self.Reliability: int = None
self.Out_Of_Tolerance: int = None
self.Evm_Low: enums.ResultStatus2 = None
self.Evm_High: enums.ResultStatus2 = None
self.Mag_Err_Low: enums.ResultStatus2 = None
self.Mag_Err_High: enums.ResultStatus2 = None
self.Ph_Error_Low: enums.ResultStatus2 = None
self.Ph_Error_High: enums.ResultStatus2 = None
[docs]
def calculate(self, carrierComponent=repcap.CarrierComponent.Default, layer=repcap.Layer.Default) -> CalculateStruct:
"""
``CALCulate:NRSub:MEASurement<Instance>:MEValuation[:CC<no>][:LAYer<layer>]:MODulation:PSCCh:CURRent`` \n
Snippet: ``value: CalculateStruct = driver.nrSubMeas.multiEval.cc.layer.modulation.pscch.current.calculate(carrierComponent = repcap.CarrierComponent.Default, layer = repcap.Layer.Default)`` \n
Return the current, average, extreme and standard deviation single-value PSCCH results for carrier <no>, layer/antenna
<l>. The values described below are returned by FETCh and READ commands. A CALCulate command returns limit check results
instead, one value for each result listed below.
:param carrierComponent: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cc')
:param layer: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Layer')
:return: structure: for return value, see the help for CalculateStruct structure arguments.
"""
carrierComponent_cmd_val = self._cmd_group.get_repcap_cmd_value(carrierComponent, repcap.CarrierComponent)
layer_cmd_val = self._cmd_group.get_repcap_cmd_value(layer, repcap.Layer)
return self._core.io.query_struct(f'CALCulate:NRSub:MEASurement<Instance>:MEValuation:CC{carrierComponent_cmd_val}:LAYer{layer_cmd_val}:MODulation:PSCCh:CURRent?', self.__class__.CalculateStruct())