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 set(self, cell_name: str, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> None:
"""
``BUS<*>:CMSB:FRAMe<*>:CELL<*>:NAME`` \n
Snippet: ``driver.bus.cmsb.frame.cell.name.set(cell_name = 'abc', bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
Enables the user to set a cell name within a frame. Names do not have to be unique, they are just for user support.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
: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(cell_name)
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
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)
self._core.io.write(f'BUS{bus_cmd_val}:CMSB:FRAMe{busFrameNull_cmd_val}:CELL{busCellNull_cmd_val}:NAME {param}')
[docs]
def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> str:
"""
``BUS<*>:CMSB:FRAMe<*>:CELL<*>:NAME`` \n
Snippet: ``value: str = driver.bus.cmsb.frame.cell.name.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
Enables the user to set a cell name within a frame. Names do not have to be unique, they are just for user support.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
: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')
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
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'BUS{bus_cmd_val}:CMSB:FRAMe{busFrameNull_cmd_val}:CELL{busCellNull_cmd_val}:NAME?')
return trim_str_response(response)