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 ValueCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("value", core, parent)
[docs]
def set(self, signal_value: enums.SignalSource=None, cursor=repcap.Cursor.Default) -> None:
"""
``CURSor<*>:YDELta[:VALue]`` \n
Snippet: ``driver.cursor.ydelta.value.set(signal_value = enums.SignalSource.C1, cursor = repcap.Cursor.Default)`` \n
Returns the delta value (distance) of the two horizontal cursor lines. In multiple source mode, specify the signal for
which you want to get the value.
:param signal_value: Only relevant for method ``RsMxo.cursor.smode.set()`` . One of the sources that are specified with method ``RsMxo.cursor.source.set()`` .
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
"""
param = ''
if signal_value:
param = Conversions.enum_scalar_to_str(signal_value, enums.SignalSource)
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
self._core.io.write(f'CURSor{cursor_cmd_val}:YDELta:VALue {param}'.strip())
[docs]
def get(self, cursor=repcap.Cursor.Default) -> float:
"""
``CURSor<*>:YDELta[:VALue]`` \n
Snippet: ``value: float = driver.cursor.ydelta.value.get(cursor = repcap.Cursor.Default)`` \n
Returns the delta value (distance) of the two horizontal cursor lines. In multiple source mode, specify the signal for
which you want to get the value.
:param cursor: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cursor')
:return: value: Inverse value of the delta value of the two horizontal cursor lines.
"""
cursor_cmd_val = self._cmd_group.get_repcap_cmd_value(cursor, repcap.Cursor)
response = self._core.io.query_str(f'CURSor{cursor_cmd_val}:YDELta:VALue?')
return Conversions.str_to_float(response)