from .........Internal.Core import Core
from .........Internal.CommandsGroup import CommandsGroup
from .........Internal import Conversions
from ......... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class VoffsetCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("voffset", core, parent)
[docs]
def set(self, voffset: float, window=repcap.Window.Default, trace=repcap.Trace.Default) -> None:
"""
``DISPlay[:WINDow<n>]:TRACe<t>:X[:SCALe]:VOFFset`` \n
Snippet: ``driver.applications.k70Vsa.display.window.trace.x.scale.voffset.set(voffset = 1.0, window = repcap.Window.Default, trace = repcap.Trace.Default)`` \n
Defines an offset to numbering of the symbols (Except capture buffer) .
:param voffset: Range: -100000 to 100000, Unit: none
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Window')
:param trace: optional repeated capability selector. Default value: Tr1 (settable in the interface 'Trace')
"""
param = Conversions.decimal_value_to_str(voffset)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
trace_cmd_val = self._cmd_group.get_repcap_cmd_value(trace, repcap.Trace)
self._core.io.write(f'DISPlay:WINDow{window_cmd_val}:TRACe{trace_cmd_val}:X:SCALe:VOFFset {param}')
[docs]
def get(self, window=repcap.Window.Default, trace=repcap.Trace.Default) -> float:
"""
``DISPlay[:WINDow<n>]:TRACe<t>:X[:SCALe]:VOFFset`` \n
Snippet: ``value: float = driver.applications.k70Vsa.display.window.trace.x.scale.voffset.get(window = repcap.Window.Default, trace = repcap.Trace.Default)`` \n
Defines an offset to numbering of the symbols (Except capture buffer) .
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Window')
:param trace: optional repeated capability selector. Default value: Tr1 (settable in the interface 'Trace')
:return: voffset: Range: -100000 to 100000, Unit: none
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
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}:TRACe{trace_cmd_val}:X:SCALe:VOFFset?')
return Conversions.str_to_float(response)