from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from .......Internal.Utilities import trim_str_response
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class NameCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("name", core, parent)
[docs]
def get(self, search: str, searchResCmsb=repcap.SearchResCmsb.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> str:
"""
``SEARch:RESult:CMSB<*>:FRAMe<*>:CELL<*>:NAME`` \n
Snippet: ``value: str = driver.search.result.cmsb.frame.cell.name.get(search = 'abc', searchResCmsb = repcap.SearchResCmsb.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
Returns the name of the specified cell within the search result. Cell names are not necessarily unique.
:param searchResCmsb: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cmsb')
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:param busCellNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cell')
"""
param = Conversions.value_to_quoted_str(search)
searchResCmsb_cmd_val = self._cmd_group.get_repcap_cmd_value(searchResCmsb, repcap.SearchResCmsb)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
busCellNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busCellNull, repcap.BusCellNull)
response = self._core.io.query_str(f'SEARch:RESult:CMSB{searchResCmsb_cmd_val}:FRAMe{busFrameNull_cmd_val}:CELL{busCellNull_cmd_val}:NAME? {param}')
return trim_str_response(response)