from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ScaleCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("scale", core, parent)
[docs]
def set(self, vertical_scale: float, refCurve=repcap.RefCurve.Default) -> None:
"""
``FRANalysis:REFCurve<*>:SCALe`` \n
Snippet: ``driver.franalysis.refCurve.scale.set(vertical_scale = 1.0, refCurve = repcap.RefCurve.Default)`` \n
Sets the vertical scale, which defines the displayed amplitude of the selected waveform.
:param vertical_scale: -100 to 100
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
"""
param = Conversions.decimal_value_to_str(vertical_scale)
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
self._core.io.write(f'FRANalysis:REFCurve{refCurve_cmd_val}:SCALe {param}')
[docs]
def get(self, refCurve=repcap.RefCurve.Default) -> float:
"""
``FRANalysis:REFCurve<*>:SCALe`` \n
Snippet: ``value: float = driver.franalysis.refCurve.scale.get(refCurve = repcap.RefCurve.Default)`` \n
Sets the vertical scale, which defines the displayed amplitude of the selected waveform.
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
:return: vertical_scale: -100 to 100
"""
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
response = self._core.io.query_str(f'FRANalysis:REFCurve{refCurve_cmd_val}:SCALe?')
return Conversions.str_to_float(response)