from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class EnableCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("enable", core, parent)
[docs]
def set(self, state: bool, histogram=repcap.Histogram.Default) -> None:
"""
``HISTogram<*>:ENABle`` \n
Snippet: ``driver.histogram.enable.set(state = False, histogram = repcap.Histogram.Default)`` \n
Enables or disables the histogram evaluation and display. The histogram settings are kept until the histogram is deleted.
:param state: OFF | ON
:param histogram: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Histogram')
"""
param = Conversions.bool_to_str(state)
histogram_cmd_val = self._cmd_group.get_repcap_cmd_value(histogram, repcap.Histogram)
self._core.io.write(f'HISTogram{histogram_cmd_val}:ENABle {param}')
[docs]
def get(self, histogram=repcap.Histogram.Default) -> bool:
"""
``HISTogram<*>:ENABle`` \n
Snippet: ``value: bool = driver.histogram.enable.get(histogram = repcap.Histogram.Default)`` \n
Enables or disables the histogram evaluation and display. The histogram settings are kept until the histogram is deleted.
:param histogram: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Histogram')
:return: state: OFF | ON
"""
histogram_cmd_val = self._cmd_group.get_repcap_cmd_value(histogram, repcap.Histogram)
response = self._core.io.query_str(f'HISTogram{histogram_cmd_val}:ENABle?')
return Conversions.str_to_bool(response)