from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StartCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("start", core, parent)
[docs]
def set(self, offset_frequency: float, window=repcap.Window.Default, userRange=repcap.UserRange.Default) -> None:
"""
``CALCulate<n>:EVALuation:USER<res>:STARt`` \n
Snippet: ``driver.applications.k40PhaseNoise.calculate.evaluation.user.start.set(offset_frequency = 1.0, window = repcap.Window.Default, userRange = repcap.UserRange.Default)`` \n
No help available
:param offset_frequency: Unit: HZ
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param userRange: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
"""
param = Conversions.decimal_value_to_str(offset_frequency)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
userRange_cmd_val = self._cmd_group.get_repcap_cmd_value(userRange, repcap.UserRange)
self._core.io.write(f'CALCulate{window_cmd_val}:EVALuation:USER{userRange_cmd_val}:STARt {param}')
[docs]
def get(self, window=repcap.Window.Default, userRange=repcap.UserRange.Default) -> float:
"""
``CALCulate<n>:EVALuation:USER<res>:STARt`` \n
Snippet: ``value: float = driver.applications.k40PhaseNoise.calculate.evaluation.user.start.get(window = repcap.Window.Default, userRange = repcap.UserRange.Default)`` \n
No help available
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param userRange: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
:return: offset_frequency: Unit: HZ
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
userRange_cmd_val = self._cmd_group.get_repcap_cmd_value(userRange, repcap.UserRange)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:EVALuation:USER{userRange_cmd_val}:STARt?')
return Conversions.str_to_float(response)