from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class TpcCls:
"""
| Commands in total: 12
| Subgroups: 3
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("tpc", core, parent)
@property
def state(self):
"""
| Commands in total: 2
| Subgroups: 1
| Direct child commands: 1
"""
if not hasattr(self, '_state'):
from .State import StateCls
self._state = StateCls(self._core, self._cmd_group)
return self._state
@property
def trace(self):
"""
| Commands in total: 6
| Subgroups: 2
| Direct child commands: 0
"""
if not hasattr(self, '_trace'):
from .Trace import TraceCls
self._trace = TraceCls(self._core, self._cmd_group)
return self._trace
@property
def psteps(self):
"""
| Commands in total: 1
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_psteps'):
from .Psteps import PstepsCls
self._psteps = PstepsCls(self._core, self._cmd_group)
return self._psteps
[docs]
def initiate(self, opc_timeout_ms: int = -1) -> None:
"""
``INITiate:NRSub:MEASurement<Instance>:TPC`` \n
Snippet: ``driver.nrSubMeas.tpc.initiate()`` \n
Starts, stops or aborts the measurement: \n
- The INITiate:... command starts or restarts the measurement. The measurement enters the RUN state.
- The STOP:... command halts the measurement immediately. The measurement enters the RDY state. Measurement results are kept. The resources remain allocated to the measurement.
- The ABORt:... command halts the measurement immediately. The measurement enters the OFF state. All measurement values are set to NAV. Allocated resources are released.
To query the current measurement state, use FETCh...STATe?.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'INITiate:NRSub:MEASurement<Instance>:TPC', opc_timeout_ms)
[docs]
def stop(self) -> None:
"""
``STOP:NRSub:MEASurement<Instance>:TPC`` \n
Snippet: ``driver.nrSubMeas.tpc.stop()`` \n
Starts, stops or aborts the measurement: \n
- The INITiate:... command starts or restarts the measurement. The measurement enters the RUN state.
- The STOP:... command halts the measurement immediately. The measurement enters the RDY state. Measurement results are kept. The resources remain allocated to the measurement.
- The ABORt:... command halts the measurement immediately. The measurement enters the OFF state. All measurement values are set to NAV. Allocated resources are released.
To query the current measurement state, use FETCh...STATe?.
"""
self._core.io.write(f'STOP:NRSub:MEASurement<Instance>:TPC')
[docs]
def stop_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``STOP:NRSub:MEASurement<Instance>:TPC`` \n
Snippet: ``driver.nrSubMeas.tpc.stop_with_opc()`` \n
Starts, stops or aborts the measurement: \n
- The INITiate:... command starts or restarts the measurement. The measurement enters the RUN state.
- The STOP:... command halts the measurement immediately. The measurement enters the RDY state. Measurement results are kept. The resources remain allocated to the measurement.
- The ABORt:... command halts the measurement immediately. The measurement enters the OFF state. All measurement values are set to NAV. Allocated resources are released.
To query the current measurement state, use FETCh...STATe?.
Same as stop, but waits for the operation to complete before continuing further. Use the RsCMPX_NrFr1Meas.utilities.opc_timeout_set() to set the timeout value.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'STOP:NRSub:MEASurement<Instance>:TPC', opc_timeout_ms)
[docs]
def abort(self, opc_timeout_ms: int = -1) -> None:
"""
``ABORt:NRSub:MEASurement<Instance>:TPC`` \n
Snippet: ``driver.nrSubMeas.tpc.abort()`` \n
Starts, stops or aborts the measurement: \n
- The INITiate:... command starts or restarts the measurement. The measurement enters the RUN state.
- The STOP:... command halts the measurement immediately. The measurement enters the RDY state. Measurement results are kept. The resources remain allocated to the measurement.
- The ABORt:... command halts the measurement immediately. The measurement enters the OFF state. All measurement values are set to NAV. Allocated resources are released.
To query the current measurement state, use FETCh...STATe?.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'ABORt:NRSub:MEASurement<Instance>:TPC', opc_timeout_ms)
def clone(self) -> 'TpcCls':
"""
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 = TpcCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group