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, channel=repcap.Channel.Default) -> None:
"""
``CHANnel<*>:OFFSet`` \n
Snippet: ``driver.channel.offset.set(offset = 1.0, channel = repcap.Channel.Default)`` \n
Sets the offset voltage, which corrects an offset-affected signal. The vertical center of the selected channel is shifted
by the offset value and the signal is repositioned within the diagram.
:param offset: -1 to 1
:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
"""
param = Conversions.decimal_value_to_str(offset)
channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel)
self._core.io.write(f'CHANnel{channel_cmd_val}:OFFSet {param}')
[docs]
def get(self, channel=repcap.Channel.Default) -> float:
"""
``CHANnel<*>:OFFSet`` \n
Snippet: ``value: float = driver.channel.offset.get(channel = repcap.Channel.Default)`` \n
Sets the offset voltage, which corrects an offset-affected signal. The vertical center of the selected channel is shifted
by the offset value and the signal is repositioned within the diagram.
:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
:return: offset: -1 to 1
"""
channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel)
response = self._core.io.query_str(f'CHANnel{channel_cmd_val}:OFFSet?')
return Conversions.str_to_float(response)