from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class RatioCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("ratio", core, parent)
[docs]
def set(self, cst_xy_ratio: bool, waveform=repcap.Waveform.Default) -> None:
"""
``WAVeform<*>:XYCurve:RATio`` \n
Snippet: ``driver.waveform.xyCurve.ratio.set(cst_xy_ratio = False, waveform = repcap.Waveform.Default)`` \n
If enabled, the x- and y-axes maintain a constant ratio in the diagram.
:param cst_xy_ratio: OFF | ON
:param waveform: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Waveform')
"""
param = Conversions.bool_to_str(cst_xy_ratio)
waveform_cmd_val = self._cmd_group.get_repcap_cmd_value(waveform, repcap.Waveform)
self._core.io.write_with_opc(f'WAVeform{waveform_cmd_val}:XYCurve:RATio {param}')
[docs]
def get(self, waveform=repcap.Waveform.Default) -> bool:
"""
``WAVeform<*>:XYCurve:RATio`` \n
Snippet: ``value: bool = driver.waveform.xyCurve.ratio.get(waveform = repcap.Waveform.Default)`` \n
If enabled, the x- and y-axes maintain a constant ratio in the diagram.
:param waveform: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Waveform')
:return: cst_xy_ratio: OFF | ON
"""
waveform_cmd_val = self._cmd_group.get_repcap_cmd_value(waveform, repcap.Waveform)
response = self._core.io.query_str_with_opc(f'WAVeform{waveform_cmd_val}:XYCurve:RATio?')
return Conversions.str_to_bool(response)