from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ResultCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("result", core, parent)
[docs]
def get(self, trace_mode: enums.TraceModeB) -> float:
"""
``[SENSe]:ADEMod:FM:AFSPectrum:RESult`` \n
Snippet: ``value: float = driver.sense.ademod.fm.afSpectrum.result.get(trace_mode = enums.TraceModeB.AVERage)`` \n
Reads the result data of the evaluated signal in the specified trace mode. The data format of the output data block is
defined by the FORMat command (see method ``RsFsw.formatPy.data.set()`` ) . The trace results are configured for a
specific evaluation. The following table indicates which command syntax refers to which evaluation method, as well as the
output unit of the results.
Command syntax / Evaluation method / Output unit \n
- ACV[:TDOMain] / AC-Video time domain / V
- ACV:AFSpectrum / AC-Video spectrum / V
- AM[:ABSolute][:TDOMain] / RF time domain / dBm
- AM:RELative[:TDOMain] / AM time domain / %
- AM:RELative:AFSPectrum / AM spectrum / %
- FM[:TDOMain] / FM time domain / kHz
- FM:AFSPectrum / FM spectrum / kHz
- PM[:TDOMain] / PM time domain / rad or °
- PM:AFSPectrum / PM spectrum / rad or °
- SPECtrum / RF spectrum / dBm (logarithmic display) or V (linear display) .
:param trace_mode: WRITe | AVERage | MAXHold | MINHold
:return: trace_mode_result: The specified trace mode must be one of those configured by SENS:ADEM:Evaluation:TYPE, see method ``RsFsw.sense.ademod.spectrum.typePy.set()`` . Otherwise a query error is generated.
"""
param = Conversions.enum_scalar_to_str(trace_mode, enums.TraceModeB)
response = self._core.io.query_str(f'SENSe:ADEMod:FM:AFSPectrum:RESult? {param}')
return Conversions.str_to_float(response)