from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SareaCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("sarea", core, parent)
[docs]
def set(self, search_area: enums.SearchArea, window=repcap.Window.Default, marker=repcap.Marker.Default) -> None:
"""
``CALCulate<n>:MARKer<m>:SPECtrogram:SARea`` \n
Snippet: ``driver.calculate.marker.spectrogram.sarea.set(search_area = enums.SearchArea.MEMory, window = repcap.Window.Default, marker = repcap.Marker.Default)`` \n
Defines the marker search area for all spectrogram markers in the channel.
:param search_area: VISible Performs a search within the visible frames. Note that the command does not work if the spectrogram is not visible for any reason (e.g. if the display update is off) . MEMory Performs a search within all frames in the memory.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker')
"""
param = Conversions.enum_scalar_to_str(search_area, enums.SearchArea)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker)
self._core.io.write(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:SPECtrogram:SARea {param}')
# noinspection PyTypeChecker
[docs]
def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default) -> enums.SearchArea:
"""
``CALCulate<n>:MARKer<m>:SPECtrogram:SARea`` \n
Snippet: ``value: enums.SearchArea = driver.calculate.marker.spectrogram.sarea.get(window = repcap.Window.Default, marker = repcap.Marker.Default)`` \n
Defines the marker search area for all spectrogram markers in the channel.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker')
:return: search_area: VISible Performs a search within the visible frames. Note that the command does not work if the spectrogram is not visible for any reason (e.g. if the display update is off) . MEMory Performs a search within all frames in the memory.
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:SPECtrogram:SARea?')
return Conversions.str_to_scalar_enum(response, enums.SearchArea)