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 ModeCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("mode", core, parent)
[docs]
def set(self, result_mode: enums.PositionMode, measurement=repcap.Measurement.Default, measResult=repcap.MeasResult.Default) -> None:
"""
``MEASurement<*>:SPECtrum:RESult<*>:MODE`` \n
Snippet: ``driver.measurement.spectrum.result.mode.set(result_mode = enums.PositionMode.ABS, measurement = repcap.Measurement.Default, measResult = repcap.MeasResult.Default)`` \n
Sets the way how the measurement results are displayed. Available only if method ``RsRtx.measurement.main.set()`` is set
to PLISt or HAR.
:param result_mode: ABS | REL \n
- ABS: The harmonics/peaks are shown in absolute value, dBm.
- REL: The level of the carrier is shown in absolute value dBm. The values the harmonics/peaks are shown relatively to the carrier in dBc.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:param measResult: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Result')
"""
param = Conversions.enum_scalar_to_str(result_mode, enums.PositionMode)
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
measResult_cmd_val = self._cmd_group.get_repcap_cmd_value(measResult, repcap.MeasResult)
self._core.io.write_with_opc(f'MEASurement{measurement_cmd_val}:SPECtrum:RESult{measResult_cmd_val}:MODE {param}')
# noinspection PyTypeChecker
[docs]
def get(self, measurement=repcap.Measurement.Default, measResult=repcap.MeasResult.Default) -> enums.PositionMode:
"""
``MEASurement<*>:SPECtrum:RESult<*>:MODE`` \n
Snippet: ``value: enums.PositionMode = driver.measurement.spectrum.result.mode.get(measurement = repcap.Measurement.Default, measResult = repcap.MeasResult.Default)`` \n
Sets the way how the measurement results are displayed. Available only if method ``RsRtx.measurement.main.set()`` is set
to PLISt or HAR.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:param measResult: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Result')
:return: result_mode: ABS | REL \n
- ABS: The harmonics/peaks are shown in absolute value, dBm.
- REL: The level of the carrier is shown in absolute value dBm. The values the harmonics/peaks are shown relatively to the carrier in dBc.
"""
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
measResult_cmd_val = self._cmd_group.get_repcap_cmd_value(measResult, repcap.MeasResult)
response = self._core.io.query_str_with_opc(f'MEASurement{measurement_cmd_val}:SPECtrum:RESult{measResult_cmd_val}:MODE?')
return Conversions.str_to_scalar_enum(response, enums.PositionMode)