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, auto_level_mode: enums.AutoLevelMode, refLevel=repcap.RefLevel.Default) -> None:
"""
``REFLevel<*>:AUTO:MODE`` \n
Snippet: ``driver.refLevel.auto.mode.set(auto_level_mode = enums.AutoLevelMode.ABSolutepeak, refLevel = repcap.RefLevel.Default)`` \n
Defines the high and low signal levels from which the reference levels are derived.
:param auto_level_mode: AUTO | PPRobability | MPRobability | ABSolutepeak \n
- AUTO: Auto select absolute probability: most suitable signal levels
- PPRobability: Peak probability: signal levels with the highest probability value
- MPRobability: Mean probability: signal levels with mean probability
- ABSolutepeak: Absolute peak: absolute peak signal levels
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
"""
param = Conversions.enum_scalar_to_str(auto_level_mode, enums.AutoLevelMode)
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
self._core.io.write(f'REFLevel{refLevel_cmd_val}:AUTO:MODE {param}')
# noinspection PyTypeChecker
[docs]
def get(self, refLevel=repcap.RefLevel.Default) -> enums.AutoLevelMode:
"""
``REFLevel<*>:AUTO:MODE`` \n
Snippet: ``value: enums.AutoLevelMode = driver.refLevel.auto.mode.get(refLevel = repcap.RefLevel.Default)`` \n
Defines the high and low signal levels from which the reference levels are derived.
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
:return: auto_level_mode: AUTO | PPRobability | MPRobability | ABSolutepeak \n
- AUTO: Auto select absolute probability: most suitable signal levels
- PPRobability: Peak probability: signal levels with the highest probability value
- MPRobability: Mean probability: signal levels with mean probability
- ABSolutepeak: Absolute peak: absolute peak signal levels
"""
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
response = self._core.io.query_str(f'REFLevel{refLevel_cmd_val}:AUTO:MODE?')
return Conversions.str_to_scalar_enum(response, enums.AutoLevelMode)