from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PhaseShiftCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("phaseShift", core, parent)
[docs]
def set(self, phase_shift: float, wgenerator=repcap.Wgenerator.Default) -> None:
"""
``WGENerator<*>:COUPling:PHASeshift`` \n
Snippet: ``driver.wgenerator.coupling.phaseShift.set(phase_shift = 1.0, wgenerator = repcap.Wgenerator.Default)`` \n
Sets the phase shift between the waveform of Gen1 and Gen2 when the frequency parameters of the two waveforms are coupled.
:param phase_shift: -180 to 180
:param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator')
"""
param = Conversions.decimal_value_to_str(phase_shift)
wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator)
self._core.io.write(f'WGENerator{wgenerator_cmd_val}:COUPling:PHASeshift {param}')
[docs]
def get(self, wgenerator=repcap.Wgenerator.Default) -> float:
"""
``WGENerator<*>:COUPling:PHASeshift`` \n
Snippet: ``value: float = driver.wgenerator.coupling.phaseShift.get(wgenerator = repcap.Wgenerator.Default)`` \n
Sets the phase shift between the waveform of Gen1 and Gen2 when the frequency parameters of the two waveforms are coupled.
:param wgenerator: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Wgenerator')
:return: phase_shift: -180 to 180
"""
wgenerator_cmd_val = self._cmd_group.get_repcap_cmd_value(wgenerator, repcap.Wgenerator)
response = self._core.io.query_str(f'WGENerator{wgenerator_cmd_val}:COUPling:PHASeshift?')
return Conversions.str_to_float(response)