from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class OffsetCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("offset", core, parent)
[docs]
def set(self, offset: float, refCurve=repcap.RefCurve.Default) -> None:
"""
``REFCurve<*>:RESCale:VERTical:OFFSet`` \n
Snippet: ``driver.refCurve.rescale.vertical.offset.set(offset = 1.0, refCurve = repcap.RefCurve.Default)`` \n
The vertical offset moves the reference waveform vertically. Enter a value with the unit of the waveform. Like vertical
offset of a channel waveform, the offset of a reference waveform is subtracted from the measured value. Negative values
shift the waveform up, positive values shift it down.
:param offset: -100000000 to 100000000
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
"""
param = Conversions.decimal_value_to_str(offset)
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
self._core.io.write(f'REFCurve{refCurve_cmd_val}:RESCale:VERTical:OFFSet {param}')
[docs]
def get(self, refCurve=repcap.RefCurve.Default) -> float:
"""
``REFCurve<*>:RESCale:VERTical:OFFSet`` \n
Snippet: ``value: float = driver.refCurve.rescale.vertical.offset.get(refCurve = repcap.RefCurve.Default)`` \n
The vertical offset moves the reference waveform vertically. Enter a value with the unit of the waveform. Like vertical
offset of a channel waveform, the offset of a reference waveform is subtracted from the measured value. Negative values
shift the waveform up, positive values shift it down.
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
:return: offset: -100000000 to 100000000
"""
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
response = self._core.io.query_str(f'REFCurve{refCurve_cmd_val}:RESCale:VERTical:OFFSet?')
return Conversions.str_to_float(response)