Source code for rsrtx.Implementations.Channel.Waveform.History.Current

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class CurrentCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("current", core, parent)

[docs] def set(self, curr_acq_idx: int, channel=repcap.Channel.Default, waveform=repcap.Waveform.Default) -> None: """ ``CHANnel<*>[:WAVeform<*>]:HISTory:CURRent`` \n Snippet: ``driver.channel.waveform.history.current.set(curr_acq_idx = 1, channel = repcap.Channel.Default, waveform = repcap.Waveform.Default)`` \n Accesses a particular acquisition in the memory to display it. The query returns the index of the segment that is shown. :param curr_acq_idx: History index: the newest segment has the index '0', older segments have a negative index: -(n-1) , .... -1 , 0 where n is the number of acquired segments. :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(curr_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:CURRent {param}')
[docs] def get(self, channel=repcap.Channel.Default, waveform=repcap.Waveform.Default) -> int: """ ``CHANnel<*>[:WAVeform<*>]:HISTory:CURRent`` \n Snippet: ``value: int = driver.channel.waveform.history.current.get(channel = repcap.Channel.Default, waveform = repcap.Waveform.Default)`` \n Accesses a particular acquisition in the memory to display it. The query returns the index of the segment that is shown. :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: curr_acq_idx: History index: the newest segment has the index '0', older segments have a negative index: -(n-1) , .... -1 , 0 where n is the number of acquired segments. """ 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:CURRent?') return Conversions.str_to_int(response)