from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal.Types import DataType
from ....Internal.StructBase import StructBase
from ....Internal.ArgStruct import ArgStruct
from ....Internal.ArgSingleList import ArgSingleList
from ....Internal.ArgSingle import ArgSingle
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class SpeakCls:
"""Speak commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("speak", core, parent)
# noinspection PyTypeChecker
[docs]
class FetchStruct(StructBase):
"""Response structure. Fields: \n
- Reliability: int: decimal See 'Reliability indicator'
- Xvalue: float: float X value
- Yvalue: float: float Y value Unit: dBm"""
__meta_args_list = [
ArgStruct.scalar_int('Reliability', 'Reliability'),
ArgStruct.scalar_float('Xvalue'),
ArgStruct.scalar_float('Yvalue')]
def __init__(self):
StructBase.__init__(self, self)
self.Reliability: int = None
self.Xvalue: float = None
self.Yvalue: float = None
[docs]
def fetch(self, detector: enums.Detector, statistic: enums.Statistic) -> FetchStruct:
"""SCPI: FETCh:GPRF:MEASurement<Instance>:SPECtrum:REFMarker:SPEak \n
Snippet: value: FetchStruct = driver.spectrum.referenceMarker.speak.fetch(detector = enums.Detector.AUTopeak, statistic = enums.Statistic.AVERage) \n
Moves the reference marker to the highest peak of the trace determined by <Detector> and <Statistic> and returns the X
and Y value of the new marker position. \n
:param detector: AVERage | RMS | SAMPle | MINPeak | MAXPeak | AUTopeak Selects the detector type, see 'Detector hotkey'.
:param statistic: CURRent | AVERage | MAXimum | MINimum Selects the trace type.
:return: structure: for return value, see the help for FetchStruct structure arguments."""
param = ArgSingleList().compose_cmd_string(ArgSingle('detector', detector, DataType.Enum, enums.Detector), ArgSingle('statistic', statistic, DataType.Enum, enums.Statistic))
return self._core.io.query_struct(f'FETCh:GPRF:MEASurement<Instance>:SPECtrum:REFMarker:SPEak? {param}'.rstrip(), self.__class__.FetchStruct())