from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class XCls:
"""X commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("x", core, parent)
[docs] def set(self, frequency: float, window=repcap.Window.Default) -> None:
"""SCPI: CALCulate<n>:MASK:UPPer:SHIFt:X \n
Snippet: driver.calculate.mask.upper.shift.x.set(frequency = 1.0, window = repcap.Window.Default) \n
Shifts the lower frequency mask horizontally by a specified distance. Positive values move the mask to the right,
negative values shift the mask to the left. You have to select a mask before you can use this command with method RsFsw.
Calculate.Mask.Name.set. \n
:param frequency: Defines the distance of the shift. Unit: HZ
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
"""
param = Conversions.decimal_value_to_str(frequency)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'CALCulate{window_cmd_val}:MASK:UPPer:SHIFt:X {param}')
[docs] def get(self, window=repcap.Window.Default) -> float:
"""SCPI: CALCulate<n>:MASK:UPPer:SHIFt:X \n
Snippet: value: float = driver.calculate.mask.upper.shift.x.get(window = repcap.Window.Default) \n
Shifts the lower frequency mask horizontally by a specified distance. Positive values move the mask to the right,
negative values shift the mask to the left. You have to select a mask before you can use this command with method RsFsw.
Calculate.Mask.Name.set. \n
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:return: frequency: Defines the distance of the shift. Unit: HZ"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:MASK:UPPer:SHIFt:X?')
return Conversions.str_to_float(response)