from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import enums
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SpacingCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("spacing", core, parent)
[docs]
def set(self, scaling_type: enums.SpacingY, window=repcap.Window.Default, subWindow=repcap.SubWindow.Default, trace=repcap.Trace.Default) -> None:
"""
``DISPlay[:WINDow<n>][:SUBWindow<w>]:TRACe<t>:Y:SPACing`` \n
Snippet: ``driver.display.window.subwindow.trace.y.spacing.set(scaling_type = enums.SpacingY.LDB, window = repcap.Window.Default, subWindow = repcap.SubWindow.Default, trace = repcap.Trace.Default)`` \n
Selects the scaling of the y-axis (for all traces, <t> is irrelevant) . For AF spectrum displays, only the parameters
'LINear' and 'LOGarithmic' are permitted.
:param scaling_type: LOGarithmic Logarithmic scaling. LINear Linear scaling in %. LDB Linear scaling in the specified unit. PERCent Linear scaling in %.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Window')
:param subWindow: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Subwindow')
:param trace: optional repeated capability selector. Default value: Tr1 (settable in the interface 'Trace')
"""
param = Conversions.enum_scalar_to_str(scaling_type, enums.SpacingY)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
subWindow_cmd_val = self._cmd_group.get_repcap_cmd_value(subWindow, repcap.SubWindow)
trace_cmd_val = self._cmd_group.get_repcap_cmd_value(trace, repcap.Trace)
self._core.io.write(f'DISPlay:WINDow{window_cmd_val}:SUBWindow{subWindow_cmd_val}:TRACe{trace_cmd_val}:Y:SPACing {param}')
# noinspection PyTypeChecker
[docs]
def get(self, window=repcap.Window.Default, subWindow=repcap.SubWindow.Default, trace=repcap.Trace.Default) -> enums.SpacingY:
"""
``DISPlay[:WINDow<n>][:SUBWindow<w>]:TRACe<t>:Y:SPACing`` \n
Snippet: ``value: enums.SpacingY = driver.display.window.subwindow.trace.y.spacing.get(window = repcap.Window.Default, subWindow = repcap.SubWindow.Default, trace = repcap.Trace.Default)`` \n
Selects the scaling of the y-axis (for all traces, <t> is irrelevant) . For AF spectrum displays, only the parameters
'LINear' and 'LOGarithmic' are permitted.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Window')
:param subWindow: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Subwindow')
:param trace: optional repeated capability selector. Default value: Tr1 (settable in the interface 'Trace')
:return: scaling_type: LOGarithmic Logarithmic scaling. LINear Linear scaling in %. LDB Linear scaling in the specified unit. PERCent Linear scaling in %.
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
subWindow_cmd_val = self._cmd_group.get_repcap_cmd_value(subWindow, repcap.SubWindow)
trace_cmd_val = self._cmd_group.get_repcap_cmd_value(trace, repcap.Trace)
response = self._core.io.query_str(f'DISPlay:WINDow{window_cmd_val}:SUBWindow{subWindow_cmd_val}:TRACe{trace_cmd_val}:Y:SPACing?')
return Conversions.str_to_scalar_enum(response, enums.SpacingY)