from typing import List
from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SlistCls:
"""
| Commands in total: 9
| Subgroups: 4
| Direct child commands: 2
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("slist", core, parent)
@property
def clear(self):
"""
| Commands in total: 2
| Subgroups: 2
| Direct child commands: 0
"""
if not hasattr(self, '_clear'):
from .Clear import ClearCls
self._clear = ClearCls(self._core, self._cmd_group)
return self._clear
@property
def element(self):
"""
| Commands in total: 1
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_element'):
from .Element import ElementCls
self._element = ElementCls(self._core, self._cmd_group)
return self._element
@property
def scan(self):
"""
| Commands in total: 3
| Subgroups: 1
| Direct child commands: 2
"""
if not hasattr(self, '_scan'):
from .Scan import ScanCls
self._scan = ScanCls(self._core, self._cmd_group)
return self._scan
@property
def sensor(self):
"""
| Commands in total: 1
| Subgroups: 1
| Direct child commands: 0
"""
if not hasattr(self, '_sensor'):
from .Sensor import SensorCls
self._sensor = SensorCls(self._core, self._cmd_group)
return self._sensor
[docs]
def clear_all(self) -> None:
"""
``SLISt:CLEar:[ALL]`` \n
Snippet: ``driver.slist.clear_all()`` \n
Removes all entries of R&S NRP power sensors using the VISA communication protocol (USB or LAN) from the sensor mapping
list. Does not affect sensors communicating over USB legacy protocol.
"""
self._core.io.write(f'SLISt:CLEar:ALL')
[docs]
def clear_all_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``SLISt:CLEar:[ALL]`` \n
Snippet: ``driver.slist.clear_all_with_opc()`` \n
Removes all entries of R&S NRP power sensors using the VISA communication protocol (USB or LAN) from the sensor mapping
list. Does not affect sensors communicating over USB legacy protocol.
Same as clear_all, but waits for the operation to complete before continuing further. Use the RsSmw.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'SLISt:CLEar:ALL', opc_timeout_ms)
[docs]
def get_list_py(self) -> List[str]:
"""
``SLISt:[LIST]`` \n
Snippet: ``value: List[str] = driver.slist.get_list_py()`` \n
Returns a list of all detected sensors in a comma-separated string.
:return: sensor_list: String of comma-separated entries Each entry contains information on the sensor type, serial number and interface. The order of the entries does not correspond to the order the sensors are displayed in the 'NRP Sensor Mapping' dialog.
"""
response = self._core.io.query_str('SLISt:LIST?')
return Conversions.str_to_str_list(response)
def clone(self) -> 'SlistCls':
"""
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 = SlistCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group