from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class NpeakCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("npeak", core, parent)
[docs]
def get(self, pwrEfficiencyResult=repcap.PwrEfficiencyResult.Default) -> float:
"""
``POWer:EFFiciency:RESult<*>:NPEak`` \n
Snippet: ``value: float = driver.power.efficiency.result.npeak.get(pwrEfficiencyResult = repcap.PwrEfficiencyResult.Default)`` \n
Return the specified statistic result of the specified measurement type.
The command affects the content of export files as well as data retrieved with: \n
- [:ACTual]: current measurement result
- AVG: average of the long-term measurement results
- EVTCount: number of measurement results in the long-term measurement
- NPEak: negative peak value of the long-term measurement results
- PPEak: positive peak value of the long-term measurement results
- RMS: RMS value of the long-term measurement results
- STDDev: standard deviation of the long-term measurement results
:param pwrEfficiencyResult: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Result')
:return: min_peak: depends on the measured quantity
"""
pwrEfficiencyResult_cmd_val = self._cmd_group.get_repcap_cmd_value(pwrEfficiencyResult, repcap.PwrEfficiencyResult)
response = self._core.io.query_str(f'POWer:EFFiciency:RESult{pwrEfficiencyResult_cmd_val}:NPEak?')
return Conversions.str_to_float(response)