from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal import Conversions
from ........ import enums
# 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, frame_mode: enums.ConfigMode) -> None:
"""
``[SENSe]:DDEMod:PATTern:FRAMe:MODE`` \n
Snippet: ``driver.applications.k70Vsa.sense.ddemod.pattern.frame.mode.set(frame_mode = enums.ConfigMode.DEFault)`` \n
Determines whether the frame structure of the signal is configured in reference to the result range or user-defined.
Is only available if the additional Multi-Modulation Analysis option (FSW-K70M) is installed.
:param frame_mode: DEFault | USER Default A single frame is assumed to correspond to the result range defined by method ``RsFsw.applications.k70Vsa.sense.ddemod.time.set()`` . User-Defined A frame is defined manually as a succession of subframes with specified characteristics. In this case, the result range is assumed to be a single frame as specified by method ``RsFsw.applications.k70Vsa.sense.ddemod.pattern.frame.edit.structure.set()`` . If no structure is configured or loaded yet, the result range definition is used (as for 'Default') .
"""
param = Conversions.enum_scalar_to_str(frame_mode, enums.ConfigMode)
self._core.io.write(f'SENSe:DDEMod:PATTern:FRAMe:MODE {param}')
# noinspection PyTypeChecker
[docs]
def get(self) -> enums.ConfigMode:
"""
``[SENSe]:DDEMod:PATTern:FRAMe:MODE`` \n
Snippet: ``value: enums.ConfigMode = driver.applications.k70Vsa.sense.ddemod.pattern.frame.mode.get()`` \n
Determines whether the frame structure of the signal is configured in reference to the result range or user-defined.
Is only available if the additional Multi-Modulation Analysis option (FSW-K70M) is installed.
:return: frame_mode: DEFault | USER Default A single frame is assumed to correspond to the result range defined by method ``RsFsw.applications.k70Vsa.sense.ddemod.time.set()`` . User-Defined A frame is defined manually as a succession of subframes with specified characteristics. In this case, the result range is assumed to be a single frame as specified by method ``RsFsw.applications.k70Vsa.sense.ddemod.pattern.frame.edit.structure.set()`` . If no structure is configured or loaded yet, the result range definition is used (as for 'Default') .
"""
response = self._core.io.query_str(f'SENSe:DDEMod:PATTern:FRAMe:MODE?')
return Conversions.str_to_scalar_enum(response, enums.ConfigMode)