from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class SpectrumCls:
"""Spectrum commands group definition. 48 total commands, 8 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("spectrum", core, parent)
@property
def state(self):
"""state commands group. 1 Sub-classes, 1 commands."""
if not hasattr(self, '_state'):
from .State import StateCls
self._state = StateCls(self._core, self._cmd_group)
return self._state
@property
def referenceMarker(self):
"""referenceMarker commands group. 2 Sub-classes, 0 commands."""
if not hasattr(self, '_referenceMarker'):
from .ReferenceMarker import ReferenceMarkerCls
self._referenceMarker = ReferenceMarkerCls(self._core, self._cmd_group)
return self._referenceMarker
@property
def marker(self):
"""marker commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_marker'):
from .Marker import MarkerCls
self._marker = MarkerCls(self._core, self._cmd_group)
return self._marker
@property
def sample(self):
"""sample commands group. 4 Sub-classes, 0 commands."""
if not hasattr(self, '_sample'):
from .Sample import SampleCls
self._sample = SampleCls(self._core, self._cmd_group)
return self._sample
@property
def rms(self):
"""rms commands group. 4 Sub-classes, 0 commands."""
if not hasattr(self, '_rms'):
from .Rms import RmsCls
self._rms = RmsCls(self._core, self._cmd_group)
return self._rms
@property
def maximum(self):
"""maximum commands group. 4 Sub-classes, 0 commands."""
if not hasattr(self, '_maximum'):
from .Maximum import MaximumCls
self._maximum = MaximumCls(self._core, self._cmd_group)
return self._maximum
@property
def minimum(self):
"""minimum commands group. 4 Sub-classes, 0 commands."""
if not hasattr(self, '_minimum'):
from .Minimum import MinimumCls
self._minimum = MinimumCls(self._core, self._cmd_group)
return self._minimum
@property
def average(self):
"""average commands group. 4 Sub-classes, 0 commands."""
if not hasattr(self, '_average'):
from .Average import AverageCls
self._average = AverageCls(self._core, self._cmd_group)
return self._average
[docs]
def initiate(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: INITiate:GPRF:MEASurement<Instance>:SPECtrum \n
Snippet: driver.spectrum.initiate() \n
INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n
- INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
- STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
- ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.
Use FETCh...STATe? to query the current measurement state. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'INITiate:GPRF:MEASurement<Instance>:SPECtrum', opc_timeout_ms)
[docs]
def stop(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: STOP:GPRF:MEASurement<Instance>:SPECtrum \n
Snippet: driver.spectrum.stop() \n
INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n
- INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
- STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
- ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.
Use FETCh...STATe? to query the current measurement state. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'STOP:GPRF:MEASurement<Instance>:SPECtrum', opc_timeout_ms)
[docs]
def abort(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: ABORt:GPRF:MEASurement<Instance>:SPECtrum \n
Snippet: driver.spectrum.abort() \n
INTRO_CMD_HELP: Starts, stops, or aborts the measurement: \n
- INITiate... starts or restarts the measurement. The measurement enters the 'RUN' state.
- STOP... halts the measurement immediately. The measurement enters the 'RDY' state. Measurement results are kept. The resources remain allocated to the measurement.
- ABORt... halts the measurement immediately. The measurement enters the 'OFF' state. All measurement values are set to NAV. Allocated resources are released.
Use FETCh...STATe? to query the current measurement state. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'ABORt:GPRF:MEASurement<Instance>:SPECtrum', opc_timeout_ms)
def clone(self) -> 'SpectrumCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = SpectrumCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group