from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Utilities import trim_str_response
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class IdsListCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("idsList", core, parent)
[docs]
def get(self, source: enums.SignalSource) -> str:
"""
``DISPlay:SIGNal:LABel:IDSList`` \n
Snippet: ``value: str = driver.display.signal.label.idsList.get(source = enums.SignalSource.AJ1)`` \n
Returns a list of label IDs for the specified source. Labels that are defined in the user interface get an automatic
label 'DiagramText<No>'.
:param source: See method ``RsRtx.display.signal.label.add()``.
"""
param = Conversions.enum_scalar_to_str(source, enums.SignalSource)
response = self._core.io.query_str_with_opc(f'DISPlay:SIGNal:LABel:IDSList? {param}')
return trim_str_response(response)