from .........Internal.Core import Core
from .........Internal.CommandsGroup import CommandsGroup
from .........Internal import Conversions
from ......... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class GapCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("gap", core, parent)
[docs]
def set(self, vrb_gap: int, subframeNull=repcap.SubframeNull.Default, allocationNull=repcap.AllocationNull.Default, codeword=repcap.Codeword.Default) -> None:
"""
``[SOURce<HW>]:BB:EUTRa:DL:[SUBF<ST0>]:ALLoc<CH0>:[CW<USER>]:GAP`` \n
Snippet: ``driver.source.bb.eutra.downlink.subf.alloc.cw.gap.set(vrb_gap = 1, subframeNull = repcap.SubframeNull.Default, allocationNull = repcap.AllocationNull.Default, codeword = repcap.Codeword.Default)`` \n
Enables/disables the unitization of distributed Virtual Resource Blocks (VBR) and determines whether the first or the
second VRB gap is applied.
:param vrb_gap: integer 0 A localized distribution is applied, i.e. the PDSCH mapping is performed on a direct VRB-to-PRB mapping. 1 Enables a distributed resource block allocation. The first VRB gap is used. 2 Enabled for 'Channel Bandwidths' greater than 50 RBs. The mapping is based on the second (smaller) VRB gap. Range: 0 to 2
:param subframeNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Subf')
:param allocationNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Alloc')
:param codeword: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cw')
"""
param = Conversions.decimal_value_to_str(vrb_gap)
subframeNull_cmd_val = self._cmd_group.get_repcap_cmd_value(subframeNull, repcap.SubframeNull)
allocationNull_cmd_val = self._cmd_group.get_repcap_cmd_value(allocationNull, repcap.AllocationNull)
codeword_cmd_val = self._cmd_group.get_repcap_cmd_value(codeword, repcap.Codeword)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:SUBF{subframeNull_cmd_val}:ALLoc{allocationNull_cmd_val}:CW{codeword_cmd_val}:GAP {param}')
[docs]
def get(self, subframeNull=repcap.SubframeNull.Default, allocationNull=repcap.AllocationNull.Default, codeword=repcap.Codeword.Default) -> int:
"""
``[SOURce<HW>]:BB:EUTRa:DL:[SUBF<ST0>]:ALLoc<CH0>:[CW<USER>]:GAP`` \n
Snippet: ``value: int = driver.source.bb.eutra.downlink.subf.alloc.cw.gap.get(subframeNull = repcap.SubframeNull.Default, allocationNull = repcap.AllocationNull.Default, codeword = repcap.Codeword.Default)`` \n
Enables/disables the unitization of distributed Virtual Resource Blocks (VBR) and determines whether the first or the
second VRB gap is applied.
:param subframeNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Subf')
:param allocationNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Alloc')
:param codeword: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cw')
:return: vrb_gap: integer 0 A localized distribution is applied, i.e. the PDSCH mapping is performed on a direct VRB-to-PRB mapping. 1 Enables a distributed resource block allocation. The first VRB gap is used. 2 Enabled for 'Channel Bandwidths' greater than 50 RBs. The mapping is based on the second (smaller) VRB gap. Range: 0 to 2
"""
subframeNull_cmd_val = self._cmd_group.get_repcap_cmd_value(subframeNull, repcap.SubframeNull)
allocationNull_cmd_val = self._cmd_group.get_repcap_cmd_value(allocationNull, repcap.AllocationNull)
codeword_cmd_val = self._cmd_group.get_repcap_cmd_value(codeword, repcap.Codeword)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:EUTRa:DL:SUBF{subframeNull_cmd_val}:ALLoc{allocationNull_cmd_val}:CW{codeword_cmd_val}:GAP?')
return Conversions.str_to_int(response)