Source code for RsSmbv.Implementations.Source.Bb.Tdscdma.Up.Cell.Slot.Channel.Sformat
from .........Internal.Core import Core
from .........Internal.CommandsGroup import CommandsGroup
from .........Internal import Conversions
from ......... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SformatCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("sformat", core, parent)
[docs]
def set(self, sformat: int, cell=repcap.Cell.Default, slotNull=repcap.SlotNull.Default, channelNull=repcap.ChannelNull.Default) -> None:
"""
``[SOURce<HW>]:BB:TDSCdma:UP:CELL<ST>:SLOT<CH0>:CHANnel<US0>:SFORmat`` \n
Snippet: ``driver.source.bb.tdscdma.up.cell.slot.channel.sformat.set(sformat = 1, cell = repcap.Cell.Default, slotNull = repcap.SlotNull.Default, channelNull = repcap.ChannelNull.Default)`` \n
Sets the slot format for the selected channel. A slot format defines the complete structure of a slot made of data and
control fields and includes the symbol rate. The slot format displays changes when a change is made to the 'Number of
TFCI Bits' and the 'Number of Sync Shift & TPC Bits' field settings.
:param sformat: integer Range: 0 to 69
:param cell: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cell')
:param slotNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Slot')
:param channelNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Channel')
"""
param = Conversions.decimal_value_to_str(sformat)
cell_cmd_val = self._cmd_group.get_repcap_cmd_value(cell, repcap.Cell)
slotNull_cmd_val = self._cmd_group.get_repcap_cmd_value(slotNull, repcap.SlotNull)
channelNull_cmd_val = self._cmd_group.get_repcap_cmd_value(channelNull, repcap.ChannelNull)
self._core.io.write(f'SOURce<HwInstance>:BB:TDSCdma:UP:CELL{cell_cmd_val}:SLOT{slotNull_cmd_val}:CHANnel{channelNull_cmd_val}:SFORmat {param}')
[docs]
def get(self, cell=repcap.Cell.Default, slotNull=repcap.SlotNull.Default, channelNull=repcap.ChannelNull.Default) -> int:
"""
``[SOURce<HW>]:BB:TDSCdma:UP:CELL<ST>:SLOT<CH0>:CHANnel<US0>:SFORmat`` \n
Snippet: ``value: int = driver.source.bb.tdscdma.up.cell.slot.channel.sformat.get(cell = repcap.Cell.Default, slotNull = repcap.SlotNull.Default, channelNull = repcap.ChannelNull.Default)`` \n
Sets the slot format for the selected channel. A slot format defines the complete structure of a slot made of data and
control fields and includes the symbol rate. The slot format displays changes when a change is made to the 'Number of
TFCI Bits' and the 'Number of Sync Shift & TPC Bits' field settings.
:param cell: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cell')
:param slotNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Slot')
:param channelNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Channel')
:return: sformat: integer Range: 0 to 69
"""
cell_cmd_val = self._cmd_group.get_repcap_cmd_value(cell, repcap.Cell)
slotNull_cmd_val = self._cmd_group.get_repcap_cmd_value(slotNull, repcap.SlotNull)
channelNull_cmd_val = self._cmd_group.get_repcap_cmd_value(channelNull, repcap.ChannelNull)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:TDSCdma:UP:CELL{cell_cmd_val}:SLOT{slotNull_cmd_val}:CHANnel{channelNull_cmd_val}:SFORmat?')
return Conversions.str_to_int(response)