from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
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 get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busFieldNull=repcap.BusFieldNull.Default) -> str:
"""
``BUS<*>:CANXl:FRAMe<*>:FLD<*>:LABel`` \n
Snippet: ``value: str = driver.bus.canXl.frame.fld.label.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Returns the label of the specified field in the specified frame.
: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 busFieldNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Fld')
"""
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)
busFieldNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFieldNull, repcap.BusFieldNull)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:CANXl:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:LABel?')
return trim_str_response(response)