from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ResultsCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("results", core, parent)
[docs]
def set(self, display_result: bool, measurement=repcap.Measurement.Default) -> None:
"""
``MEASurement<*>:DISPlay:RESults`` \n
Snippet: ``driver.measurement.display.results.set(display_result = False, measurement = repcap.Measurement.Default)`` \n
If enabled, the intermediate result linesare displayed in the measurement diagram. Result lines mark the samples in the
waveform that are used to obtain the measurement result. These are, for example, maximum and minimum values, mean, cycle
start and cycle end, and others.
:param display_result: OFF | ON
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
"""
param = Conversions.bool_to_str(display_result)
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
self._core.io.write_with_opc(f'MEASurement{measurement_cmd_val}:DISPlay:RESults {param}')
[docs]
def get(self, measurement=repcap.Measurement.Default) -> bool:
"""
``MEASurement<*>:DISPlay:RESults`` \n
Snippet: ``value: bool = driver.measurement.display.results.get(measurement = repcap.Measurement.Default)`` \n
If enabled, the intermediate result linesare displayed in the measurement diagram. Result lines mark the samples in the
waveform that are used to obtain the measurement result. These are, for example, maximum and minimum values, mean, cycle
start and cycle end, and others.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:return: display_result: OFF | ON
"""
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
response = self._core.io.query_str_with_opc(f'MEASurement{measurement_cmd_val}:DISPlay:RESults?')
return Conversions.str_to_bool(response)