from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StopCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("stop", core, parent)
[docs]
def set(self, stp_acq_idx: int, channel=repcap.Channel.Default, waveform=repcap.Waveform.Default) -> None:
"""
``CHANnel<*>[:WAVeform<*>]:HISTory:STOP`` \n
Snippet: ``driver.channel.waveform.history.stop.set(stp_acq_idx = 1, channel = repcap.Channel.Default, waveform = repcap.Waveform.Default)`` \n
Sets the index of the latest segment to be displayed in the history viewer.
:param stp_acq_idx: Index of the stop acquisition. The newest acquisition always has the index '0'.
:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
:param waveform: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Waveform')
"""
param = Conversions.decimal_value_to_str(stp_acq_idx)
channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel)
waveform_cmd_val = self._cmd_group.get_repcap_cmd_value(waveform, repcap.Waveform)
self._core.io.write_with_opc(f'CHANnel{channel_cmd_val}:WAVeform{waveform_cmd_val}:HISTory:STOP {param}')
[docs]
def get(self, channel=repcap.Channel.Default, waveform=repcap.Waveform.Default) -> int:
"""
``CHANnel<*>[:WAVeform<*>]:HISTory:STOP`` \n
Snippet: ``value: int = driver.channel.waveform.history.stop.get(channel = repcap.Channel.Default, waveform = repcap.Waveform.Default)`` \n
Sets the index of the latest segment to be displayed in the history viewer.
:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
:param waveform: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Waveform')
:return: stp_acq_idx: Index of the stop acquisition. The newest acquisition always has the index '0'.
"""
channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel)
waveform_cmd_val = self._cmd_group.get_repcap_cmd_value(waveform, repcap.Waveform)
response = self._core.io.query_str_with_opc(f'CHANnel{channel_cmd_val}:WAVeform{waveform_cmd_val}:HISTory:STOP?')
return Conversions.str_to_int(response)