from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DetailsCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("details", core, parent)
[docs]
def set(self, state: bool, window=repcap.Window.Default) -> None:
"""
``CALCulate<n>:ESPectrum:PSEarch:DETails`` \n
Snippet: ``driver.applications.k149Uwb.calculate.espectrum.peakSearch.details.set(state = False, window = repcap.Window.Default)`` \n
Configures how detailed the list in the Result Summary is.
:param state: ON | OFF | 1 | 0 ON | 1 Includes all detected peaks (up to a maximum defined by CALCulaten:PEAKsearch:SUBRanges) . OFF | 0 Includes only one peak per range.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
"""
param = Conversions.bool_to_str(state)
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
self._core.io.write(f'CALCulate{window_cmd_val}:ESPectrum:PSEarch:DETails {param}')
[docs]
def get(self, window=repcap.Window.Default) -> bool:
"""
``CALCulate<n>:ESPectrum:PSEarch:DETails`` \n
Snippet: ``value: bool = driver.applications.k149Uwb.calculate.espectrum.peakSearch.details.get(window = repcap.Window.Default)`` \n
Configures how detailed the list in the Result Summary is.
:param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate')
:return: state: ON | OFF | 1 | 0 ON | 1 Includes all detected peaks (up to a maximum defined by CALCulaten:PEAKsearch:SUBRanges) . OFF | 0 Includes only one peak per range.
"""
window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window)
response = self._core.io.query_str(f'CALCulate{window_cmd_val}:ESPectrum:PSEarch:DETails?')
return Conversions.str_to_bool(response)