from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal.StructBase import StructBase
from .....Internal.ArgStruct import ArgStruct
# 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 power dynamics measurements exceeding the specified power dynamics limits.
- 3 Off_Power_Before: float: OFF power mean value for the time period before SRS transmission.
- 4 On_Power_Rms: float: ON power mean value over the SRS transmission.
- 5 On_Power_Peak: float: ON power peak value for the SRS transmission
- 6 Off_Power_After: float: OFF power mean value for slot after SRS transmission.
"""
__meta_args_list = [
ArgStruct.scalar_int('Reliability', 'Reliability'),
ArgStruct.scalar_int('Out_Of_Tolerance'),
ArgStruct.scalar_float('Off_Power_Before'),
ArgStruct.scalar_float('On_Power_Rms'),
ArgStruct.scalar_float('On_Power_Peak'),
ArgStruct.scalar_float('Off_Power_After')]
def __init__(self):
StructBase.__init__(self, self)
self.Reliability: int = None
self.Out_Of_Tolerance: int = None
self.Off_Power_Before: float = None
self.On_Power_Rms: float = None
self.On_Power_Peak: float = None
self.Off_Power_After: float = None
[docs]
def read(self) -> ResultData:
"""
``READ:NRSub:MEASurement<Instance>:SRS:PDYNamics:CURRent`` \n
Snippet: ``value: ResultData = driver.nrSubMeas.srs.pdynamics.current.read()`` \n
Return the current, average, minimum, maximum and standard deviation single-value results of the power dynamics
measurement. 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.
:return: structure: for return value, see the help for ResultData structure arguments.
"""
return self._core.io.query_struct(f'READ:NRSub:MEASurement<Instance>:SRS:PDYNamics:CURRent?', self.__class__.ResultData())
[docs]
def fetch(self) -> ResultData:
"""
``FETCh:NRSub:MEASurement<Instance>:SRS:PDYNamics:CURRent`` \n
Snippet: ``value: ResultData = driver.nrSubMeas.srs.pdynamics.current.fetch()`` \n
Return the current, average, minimum, maximum and standard deviation single-value results of the power dynamics
measurement. 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.
:return: structure: for return value, see the help for ResultData structure arguments.
"""
return self._core.io.query_struct(f'FETCh:NRSub:MEASurement<Instance>:SRS:PDYNamics: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 power dynamics measurements exceeding the specified power dynamics limits.
- 3 Off_Power_Before: float | bool: OFF power mean value for the time period before SRS transmission.
- 4 On_Power_Rms: float | bool: ON power mean value over the SRS transmission.
- 5 On_Power_Peak: float | bool: ON power peak value for the SRS transmission
- 6 Off_Power_After: float | bool: OFF power mean value for slot after SRS transmission.
"""
__meta_args_list = [
ArgStruct.scalar_int('Reliability', 'Reliability'),
ArgStruct.scalar_int('Out_Of_Tolerance'),
ArgStruct.scalar_float_ext('Off_Power_Before'),
ArgStruct.scalar_float_ext('On_Power_Rms'),
ArgStruct.scalar_float_ext('On_Power_Peak'),
ArgStruct.scalar_float_ext('Off_Power_After')]
def __init__(self):
StructBase.__init__(self, self)
self.Reliability: int = None
self.Out_Of_Tolerance: int = None
self.Off_Power_Before: float | bool = None
self.On_Power_Rms: float | bool = None
self.On_Power_Peak: float | bool = None
self.Off_Power_After: float | bool = None
[docs]
def calculate(self) -> CalculateStruct:
"""
``CALCulate:NRSub:MEASurement<Instance>:SRS:PDYNamics:CURRent`` \n
Snippet: ``value: CalculateStruct = driver.nrSubMeas.srs.pdynamics.current.calculate()`` \n
Return the current, average, minimum, maximum and standard deviation single-value results of the power dynamics
measurement. 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.
:return: structure: for return value, see the help for CalculateStruct structure arguments.
"""
return self._core.io.query_struct(f'CALCulate:NRSub:MEASurement<Instance>:SRS:PDYNamics:CURRent?', self.__class__.CalculateStruct())