from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class CanalyzerCls:
"""Canalyzer commands group definition. 5 total commands, 1 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("canalyzer", 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
[docs]
def initiate(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: INITiate:GPRF:MEASurement<Instance>:CANalyzer \n
Snippet: driver.gprf.measurement.canalyzer.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>:CANalyzer', opc_timeout_ms)
[docs]
def stop(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: STOP:GPRF:MEASurement<Instance>:CANalyzer \n
Snippet: driver.gprf.measurement.canalyzer.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>:CANalyzer', opc_timeout_ms)
[docs]
def abort(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: ABORt:GPRF:MEASurement<Instance>:CANalyzer \n
Snippet: driver.gprf.measurement.canalyzer.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>:CANalyzer', opc_timeout_ms)
def clone(self) -> 'CanalyzerCls':
"""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 = CanalyzerCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group