from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.Types import DataType
from ....Internal.ArgSingleList import ArgSingleList
from ....Internal.ArgSingle import ArgSingle
from .... import enums
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class LabOrderCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("labOrder", core, parent)
[docs]
def set(self, meas_type: enums.MeasSpectrumParam, frame_type: enums.BorderType, measurement=repcap.Measurement.Default) -> None:
"""
``MEASurement<*>:RESult:LABorder`` \n
Snippet: ``driver.measurement.result.labOrder.set(meas_type = enums.MeasSpectrumParam.ACPower, frame_type = enums.BorderType.FULL, measurement = repcap.Measurement.Default)`` \n
Defines the layout of the labels.
:param meas_type: Only for peaklist measurements. For other measurment types, this command returns an error.
:param frame_type: NOBorder | UNDERLINE | FULL \n
- NOBorder: Label without border or lines.
- UNDERLINE: The label is underlined.
- FULL: The label is surrounded by a frame.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('meas_type', meas_type, DataType.Enum, enums.MeasSpectrumParam), ArgSingle('frame_type', frame_type, DataType.Enum, enums.BorderType))
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
self._core.io.write(f'MEASurement{measurement_cmd_val}:RESult:LABorder {param}'.rstrip())
# noinspection PyTypeChecker
[docs]
def get(self, meas_type: enums.MeasSpectrumParam, measurement=repcap.Measurement.Default) -> enums.BorderType:
"""
``MEASurement<*>:RESult:LABorder`` \n
Snippet: ``value: enums.BorderType = driver.measurement.result.labOrder.get(meas_type = enums.MeasSpectrumParam.ACPower, measurement = repcap.Measurement.Default)`` \n
Defines the layout of the labels.
:param meas_type: Only for peaklist measurements. For other measurment types, this command returns an error.
:param measurement: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Measurement')
:return: frame_type: NOBorder | UNDERLINE | FULL \n
- NOBorder: Label without border or lines.
- UNDERLINE: The label is underlined.
- FULL: The label is surrounded by a frame.
"""
param = Conversions.enum_scalar_to_str(meas_type, enums.MeasSpectrumParam)
measurement_cmd_val = self._cmd_group.get_repcap_cmd_value(measurement, repcap.Measurement)
response = self._core.io.query_str(f'MEASurement{measurement_cmd_val}:RESult:LABorder? {param}')
return Conversions.str_to_scalar_enum(response, enums.BorderType)