from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ClmnCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("clmn", core, parent)
[docs]
def set(self, column: enums.Column, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> None:
"""
``BUS<*>:CMSB:FRAMe<*>:CELL<*>:CLMN`` \n
Snippet: ``driver.bus.cmsb.frame.cell.clmn.set(column = enums.Column.COL1, bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
Selects which cell shall be displayed in which result column of the decode table. The decode table supports three result
columns, which have to be unique for each frame type. For different frame types, though, different result columns can be
defined to display unrelated information.
:param column: NONE | COL1 | COL2 | COL3 \n
- NONE: The result is not displayed in the decode table.
- COL1: The result is displayed in column 1 of the decode table.
- COL2: The result is displayed in column 2 of the decode table.
- COL3: The result is displayed in column 3 of the decode table.
: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.enum_scalar_to_str(column, enums.Column)
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}:CLMN {param}')
# noinspection PyTypeChecker
[docs]
def get(self, bus=repcap.Bus.Default, busFrameNull=repcap.BusFrameNull.Default, busCellNull=repcap.BusCellNull.Default) -> enums.Column:
"""
``BUS<*>:CMSB:FRAMe<*>:CELL<*>:CLMN`` \n
Snippet: ``value: enums.Column = driver.bus.cmsb.frame.cell.clmn.get(bus = repcap.Bus.Default, busFrameNull = repcap.BusFrameNull.Default, busCellNull = repcap.BusCellNull.Default)`` \n
Selects which cell shall be displayed in which result column of the decode table. The decode table supports three result
columns, which have to be unique for each frame type. For different frame types, though, different result columns can be
defined to display unrelated information.
: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')
:return: column: NONE | COL1 | COL2 | COL3 \n
- NONE: The result is not displayed in the decode table.
- COL1: The result is displayed in column 1 of the decode table.
- COL2: The result is displayed in column 2 of the decode table.
- COL3: The result is displayed in column 3 of the decode table.
"""
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}:CLMN?')
return Conversions.str_to_scalar_enum(response, enums.Column)