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 LabelCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("label", core, parent)
[docs]
def set(self, label: str, bus=repcap.Bus.Default, bitNull=repcap.BitNull.Default) -> None:
"""
``BUS<*>:PARallel:BIT<*>:LABel`` \n
Snippet: ``driver.bus.parallel.bit.label.set(label = 'abc', bus = repcap.Bus.Default, bitNull = repcap.BitNull.Default)`` \n
Sets a name for the indicated digital channel. The name is displayed in the diagram. For the parallel bus 1, you can also
use method ``RsRtx.digital.label.set()`` .
:param label: String containing the channel name
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param bitNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Bit')
"""
param = Conversions.value_to_quoted_str(label)
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
bitNull_cmd_val = self._cmd_group.get_repcap_cmd_value(bitNull, repcap.BitNull)
self._core.io.write(f'BUS{bus_cmd_val}:PARallel:BIT{bitNull_cmd_val}:LABel {param}')
[docs]
def get(self, bus=repcap.Bus.Default, bitNull=repcap.BitNull.Default) -> str:
"""
``BUS<*>:PARallel:BIT<*>:LABel`` \n
Snippet: ``value: str = driver.bus.parallel.bit.label.get(bus = repcap.Bus.Default, bitNull = repcap.BitNull.Default)`` \n
Sets a name for the indicated digital channel. The name is displayed in the diagram. For the parallel bus 1, you can also
use method ``RsRtx.digital.label.set()`` .
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param bitNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Bit')
:return: label: String containing the channel name
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
bitNull_cmd_val = self._cmd_group.get_repcap_cmd_value(bitNull, repcap.BitNull)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:PARallel:BIT{bitNull_cmd_val}:LABel?')
return trim_str_response(response)