from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class HysteresisCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("hysteresis", core, parent)
[docs]
def set(self, hyst_rel: float, power=repcap.Power.Default, refLevel=repcap.RefLevel.Default) -> None:
"""
``POWer<*>:HARMonics:REFLevel<*>:RELative:HYSTeresis`` \n
Snippet: ``driver.power.harmonics.refLevel.relative.hysteresis.set(hyst_rel = 1.0, power = repcap.Power.Default, refLevel = repcap.RefLevel.Default)`` \n
Defines a hysteresis for the middle reference level. A rise or fall from the middle reference value that does not exceed
the hysteresis is rejected as noise.
:param hyst_rel: 0 to 50
:param power: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Power')
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
"""
param = Conversions.decimal_value_to_str(hyst_rel)
power_cmd_val = self._cmd_group.get_repcap_cmd_value(power, repcap.Power)
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
self._core.io.write(f'POWer{power_cmd_val}:HARMonics:REFLevel{refLevel_cmd_val}:RELative:HYSTeresis {param}')
[docs]
def get(self, power=repcap.Power.Default, refLevel=repcap.RefLevel.Default) -> float:
"""
``POWer<*>:HARMonics:REFLevel<*>:RELative:HYSTeresis`` \n
Snippet: ``value: float = driver.power.harmonics.refLevel.relative.hysteresis.get(power = repcap.Power.Default, refLevel = repcap.RefLevel.Default)`` \n
Defines a hysteresis for the middle reference level. A rise or fall from the middle reference value that does not exceed
the hysteresis is rejected as noise.
:param power: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Power')
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
:return: hyst_rel: 0 to 50
"""
power_cmd_val = self._cmd_group.get_repcap_cmd_value(power, repcap.Power)
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
response = self._core.io.query_str(f'POWer{power_cmd_val}:HARMonics:REFLevel{refLevel_cmd_val}:RELative:HYSTeresis?')
return Conversions.str_to_float(response)