from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal.Utilities import trim_str_response
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class MessageCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("message", core, parent)
[docs]
def get(self, channel=repcap.Channel.Default) -> str:
"""
``CHANnel<*>:IQ:WARNing:MESSage`` \n
Snippet: ``value: str = driver.channel.iq.warningPy.message.get(channel = repcap.Channel.Default)`` \n
Returns the message string if method ``RsRtx.channel.iq.warningPy.state.get()`` is true.
:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
:return: warning_message: The string is: Undersampling if the carrier frequency is too fast. CF + BW/2 DevBW if bandwidth serttings do not fit. CF is the carrier frequency, BW is the filter bandwidth, and DevBW is the maximum instrument bandwidth.
"""
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:MESSage?')
return trim_str_response(response)