Source code for rsrtx.Implementations.Channel.Iq.WarningPy.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 get(self, channel=repcap.Channel.Default) -> bool: """ ``CHANnel<*>:IQ:WARNing[:STATe]`` \n Snippet: ``value: bool = driver.channel.iq.warningPy.state.get(channel = repcap.Channel.Default)`` \n Returns ON if the sampling setup results in an unfavorable combination. To get the message, use method ``RsRtx.channel.iq.warningPy.message.get()`` . :param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel') :return: warning_state: OFF | ON """ channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel) response = self._core.io.query_str(f'CHANnel{channel_cmd_val}:IQ:WARNing:STATe?') return Conversions.str_to_bool(response)