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

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


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

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

[docs] def set(self, state: bool, channel=repcap.Channel.Default, waveform=repcap.Waveform.Default) -> None: """ ``CHANnel<*>[:WAVeform<*>]:HISTory[:STATe]`` \n Snippet: ``driver.channel.waveform.history.state.set(state = False, channel = repcap.Channel.Default, waveform = repcap.Waveform.Default)`` \n Enables or disables the history display. :param state: OFF | ON :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.bool_to_str(state) 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:STATe {param}')
[docs] def get(self, channel=repcap.Channel.Default, waveform=repcap.Waveform.Default) -> bool: """ ``CHANnel<*>[:WAVeform<*>]:HISTory[:STATe]`` \n Snippet: ``value: bool = driver.channel.waveform.history.state.get(channel = repcap.Channel.Default, waveform = repcap.Waveform.Default)`` \n Enables or disables the history display. :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: state: OFF | ON """ 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:STATe?') return Conversions.str_to_bool(response)