Source code for RsFsw.Implementations.Calculate.Limit.Upper.Offset

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class OffsetCls: """Offset commands group definition. 1 total commands, 0 Subgroups, 1 group commands""" def __init__(self, core: Core, parent): self._core = core self._cmd_group = CommandsGroup("offset", core, parent)
[docs] def set(self, offset: float, window=repcap.Window.Default, limitIx=repcap.LimitIx.Default) -> None: """SCPI: CALCulate<n>:LIMit<li>:UPPer:OFFSet \n Snippet: driver.calculate.limit.upper.offset.set(offset = 1.0, window = repcap.Window.Default, limitIx = repcap.LimitIx.Default) \n Defines an offset for a complete upper limit line. Compared to shifting the limit line, an offset does not actually change the limit line definition points. \n :param offset: Numeric value. Unit: dB :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate') :param limitIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit') """ param = Conversions.decimal_value_to_str(offset) window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) limitIx_cmd_val = self._cmd_group.get_repcap_cmd_value(limitIx, repcap.LimitIx) self._core.io.write(f'CALCulate{window_cmd_val}:LIMit{limitIx_cmd_val}:UPPer:OFFSet {param}')
[docs] def get(self, window=repcap.Window.Default, limitIx=repcap.LimitIx.Default) -> float: """SCPI: CALCulate<n>:LIMit<li>:UPPer:OFFSet \n Snippet: value: float = driver.calculate.limit.upper.offset.get(window = repcap.Window.Default, limitIx = repcap.LimitIx.Default) \n Defines an offset for a complete upper limit line. Compared to shifting the limit line, an offset does not actually change the limit line definition points. \n :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate') :param limitIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit') :return: offset: Numeric value. Unit: dB""" window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) limitIx_cmd_val = self._cmd_group.get_repcap_cmd_value(limitIx, repcap.LimitIx) response = self._core.io.query_str(f'CALCulate{window_cmd_val}:LIMit{limitIx_cmd_val}:UPPer:OFFSet?') return Conversions.str_to_float(response)