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, mode: enums.RefLevelRelativeMode, refLevel=repcap.RefLevel.Default) -> None:
"""
``REFLevel<*>:RELative:MODE`` \n
Snippet: ``driver.refLevel.relative.mode.set(mode = enums.RefLevelRelativeMode.FIVE, refLevel = repcap.RefLevel.Default)`` \n
The lower, middle and upper reference levels, defined as percentages of the high signal level.
:param mode: FIVE | TEN | TWENty | USER \n
- FIVE: 5/50/95
- TEN: 10/50/90
- TWENty: 20/50/80
- USER: Set the reference levels to individual values with REFLevelrl:RELative:LOWer, REFLevelrl:RELative:MIDDle, and REFLevelrl:RELative:UPPer.
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
"""
param = Conversions.enum_scalar_to_str(mode, enums.RefLevelRelativeMode)
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
self._core.io.write_with_opc(f'REFLevel{refLevel_cmd_val}:RELative:MODE {param}')
# noinspection PyTypeChecker
[docs]
def get(self, refLevel=repcap.RefLevel.Default) -> enums.RefLevelRelativeMode:
"""
``REFLevel<*>:RELative:MODE`` \n
Snippet: ``value: enums.RefLevelRelativeMode = driver.refLevel.relative.mode.get(refLevel = repcap.RefLevel.Default)`` \n
The lower, middle and upper reference levels, defined as percentages of the high signal level.
:param refLevel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefLevel')
:return: mode: FIVE | TEN | TWENty | USER \n
- FIVE: 5/50/95
- TEN: 10/50/90
- TWENty: 20/50/80
- USER: Set the reference levels to individual values with REFLevelrl:RELative:LOWer, REFLevelrl:RELative:MIDDle, and REFLevelrl:RELative:UPPer.
"""
refLevel_cmd_val = self._cmd_group.get_repcap_cmd_value(refLevel, repcap.RefLevel)
response = self._core.io.query_str_with_opc(f'REFLevel{refLevel_cmd_val}:RELative:MODE?')
return Conversions.str_to_scalar_enum(response, enums.RefLevelRelativeMode)