from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class OffsetCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("offset", core, parent)
[docs]
def set(self, vertical_offset: float, power3PhaseMeas=repcap.Power3PhaseMeas.Default) -> None:
"""
``P3PHase<*>:QUALity:TOTal:POWer:VERTical:OFFSet`` \n
Snippet: ``driver.p3Phase.quality.total.power.vertical.offset.set(vertical_offset = 1.0, power3PhaseMeas = repcap.Power3PhaseMeas.Default)`` \n
Sets the vertical offset of the total power waveform if the relevant P3PHase<m>:{SUBSYS}:POWer:VERTical:SCALe:MODE
command is set to MANual.
:param vertical_offset: -100000000000000 to 100000000000000
:param power3PhaseMeas: optional repeated capability selector. Default value: Nr1 (settable in the interface 'P3Phase')
"""
param = Conversions.decimal_value_to_str(vertical_offset)
power3PhaseMeas_cmd_val = self._cmd_group.get_repcap_cmd_value(power3PhaseMeas, repcap.Power3PhaseMeas)
self._core.io.write(f'P3PHase{power3PhaseMeas_cmd_val}:QUALity:TOTal:POWer:VERTical:OFFSet {param}')
[docs]
def get(self, power3PhaseMeas=repcap.Power3PhaseMeas.Default) -> float:
"""
``P3PHase<*>:QUALity:TOTal:POWer:VERTical:OFFSet`` \n
Snippet: ``value: float = driver.p3Phase.quality.total.power.vertical.offset.get(power3PhaseMeas = repcap.Power3PhaseMeas.Default)`` \n
Sets the vertical offset of the total power waveform if the relevant P3PHase<m>:{SUBSYS}:POWer:VERTical:SCALe:MODE
command is set to MANual.
:param power3PhaseMeas: optional repeated capability selector. Default value: Nr1 (settable in the interface 'P3Phase')
:return: vertical_offset: -100000000000000 to 100000000000000
"""
power3PhaseMeas_cmd_val = self._cmd_group.get_repcap_cmd_value(power3PhaseMeas, repcap.Power3PhaseMeas)
response = self._core.io.query_str(f'P3PHase{power3PhaseMeas_cmd_val}:QUALity:TOTal:POWer:VERTical:OFFSet?')
return Conversions.str_to_float(response)