from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
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, line_rel_pos_rel: float, window=repcap.Window.Default) -> None:
"""
``CALCulate<n>:DLRel[:VALue]`` \n
Snippet: ``driver.applications.k70Vsa.calculate.dlRel.value.set(line_rel_pos_rel = 1.0, window = repcap.Window.Default)`` \n
Defines or queries the y-value of the relative horizontal line in the specified window. This command is only available
for eye diagrams, and only if an absolute horizontal line and a relative horizontal line are already available in the
same diagram (see method ``RsFsw.applications.k70Vsa.calculate.dlabs.state.set()`` and method
``RsFsw.applications.k70Vsa.calculate.dlRel.state.set()`` ) .
:param line_rel_pos_rel: Relative distance of the second horizontal line to the first (absolute) horizontal line.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
"""
param = Conversions.decimal_value_to_str(line_rel_pos_rel)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'CALCulate{window_cmd_val}:DLRel:VALue {param}')
[docs]
def get(self, window=repcap.Window.Default) -> float:
"""
``CALCulate<n>:DLRel[:VALue]`` \n
Snippet: ``value: float = driver.applications.k70Vsa.calculate.dlRel.value.get(window = repcap.Window.Default)`` \n
Defines or queries the y-value of the relative horizontal line in the specified window. This command is only available
for eye diagrams, and only if an absolute horizontal line and a relative horizontal line are already available in the
same diagram (see method ``RsFsw.applications.k70Vsa.calculate.dlabs.state.set()`` and method
``RsFsw.applications.k70Vsa.calculate.dlRel.state.set()`` ) .
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:return: line_rel_pos_rel: Relative distance of the second horizontal line to the first (absolute) horizontal line.
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:DLRel:VALue?')
return Conversions.str_to_float(response)