from typing import List
from .............Internal.Core import Core
from .............Internal.CommandsGroup import CommandsGroup
from .............Internal.Types import DataType
from .............Internal.StructBase import StructBase
from .............Internal.ArgStruct import ArgStruct
from .............Internal.ArgSingleList import ArgSingleList
from .............Internal.ArgSingle import ArgSingle
from ............. import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class PatternCls:
"""Pattern commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pattern", core, parent)
[docs] def set(self, res_alloc_type_0_bm: List[str], bitcount: int, cellNull=repcap.CellNull.Default, subframeNull=repcap.SubframeNull.Default, userNull=repcap.UserNull.Default, bwPartNull=repcap.BwPartNull.Default, allocationNull=repcap.AllocationNull.Default) -> None:
"""SCPI: [SOURce<HW>]:BB:NR5G:SCHed:CELL<CC(CH0)>:SUBF<SF(ST0)>:USER<US(DIR0)>:BWPart<BWP(GR0)>:ALLoc<AL(USER0)>:PDSCh:RESalloc:PATTern \n
Snippet: driver.source.bb.nr5G.scheduling.cell.subf.user.bwPart.alloc.pdsch.resAlloc.pattern.set(res_alloc_type_0_bm = ['rawAbc1', 'rawAbc2', 'rawAbc3'], bitcount = 1, cellNull = repcap.CellNull.Default, subframeNull = repcap.SubframeNull.Default, userNull = repcap.UserNull.Default, bwPartNull = repcap.BwPartNull.Default, allocationNull = repcap.AllocationNull.Default) \n
If [:SOURce<hw>]:BB:NR5G:SCHed:CELL<cc>:SUBF<sf>:USER<us>:BWPart<bwp>:ALLoc<al>:PDSCh|PUSCh:RESalloc T0, sets the PDSCH
resource block groups allocation as bit pattern. \n
:param res_alloc_type_0_bm: 19 bits
:param bitcount: integer Range: 0 to 19
:param cellNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cell')
:param subframeNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Subf')
:param userNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'User')
:param bwPartNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'BwPart')
:param allocationNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Alloc')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle.as_open_list('res_alloc_type_0_bm', res_alloc_type_0_bm, DataType.RawStringList, None), ArgSingle('bitcount', bitcount, DataType.Integer))
cellNull_cmd_val = self._cmd_group.get_repcap_cmd_value(cellNull, repcap.CellNull)
subframeNull_cmd_val = self._cmd_group.get_repcap_cmd_value(subframeNull, repcap.SubframeNull)
userNull_cmd_val = self._cmd_group.get_repcap_cmd_value(userNull, repcap.UserNull)
bwPartNull_cmd_val = self._cmd_group.get_repcap_cmd_value(bwPartNull, repcap.BwPartNull)
allocationNull_cmd_val = self._cmd_group.get_repcap_cmd_value(allocationNull, repcap.AllocationNull)
self._core.io.write(f'SOURce<HwInstance>:BB:NR5G:SCHed:CELL{cellNull_cmd_val}:SUBF{subframeNull_cmd_val}:USER{userNull_cmd_val}:BWPart{bwPartNull_cmd_val}:ALLoc{allocationNull_cmd_val}:PDSCh:RESalloc:PATTern {param}'.rstrip())
# noinspection PyTypeChecker
[docs] class PatternStruct(StructBase):
"""Response structure. Fields: \n
- Res_Alloc_Type_0_Bm: List[str]: 19 bits
- Bitcount: int: integer Range: 0 to 19"""
__meta_args_list = [
ArgStruct('Res_Alloc_Type_0_Bm', DataType.RawStringList, None, False, True, 1),
ArgStruct.scalar_int('Bitcount')]
def __init__(self):
StructBase.__init__(self, self)
self.Res_Alloc_Type_0_Bm: List[str] = None
self.Bitcount: int = None
[docs] def get(self, cellNull=repcap.CellNull.Default, subframeNull=repcap.SubframeNull.Default, userNull=repcap.UserNull.Default, bwPartNull=repcap.BwPartNull.Default, allocationNull=repcap.AllocationNull.Default) -> PatternStruct:
"""SCPI: [SOURce<HW>]:BB:NR5G:SCHed:CELL<CC(CH0)>:SUBF<SF(ST0)>:USER<US(DIR0)>:BWPart<BWP(GR0)>:ALLoc<AL(USER0)>:PDSCh:RESalloc:PATTern \n
Snippet: value: PatternStruct = driver.source.bb.nr5G.scheduling.cell.subf.user.bwPart.alloc.pdsch.resAlloc.pattern.get(cellNull = repcap.CellNull.Default, subframeNull = repcap.SubframeNull.Default, userNull = repcap.UserNull.Default, bwPartNull = repcap.BwPartNull.Default, allocationNull = repcap.AllocationNull.Default) \n
If [:SOURce<hw>]:BB:NR5G:SCHed:CELL<cc>:SUBF<sf>:USER<us>:BWPart<bwp>:ALLoc<al>:PDSCh|PUSCh:RESalloc T0, sets the PDSCH
resource block groups allocation as bit pattern. \n
:param cellNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cell')
:param subframeNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Subf')
:param userNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'User')
:param bwPartNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'BwPart')
:param allocationNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Alloc')
:return: structure: for return value, see the help for PatternStruct structure arguments."""
cellNull_cmd_val = self._cmd_group.get_repcap_cmd_value(cellNull, repcap.CellNull)
subframeNull_cmd_val = self._cmd_group.get_repcap_cmd_value(subframeNull, repcap.SubframeNull)
userNull_cmd_val = self._cmd_group.get_repcap_cmd_value(userNull, repcap.UserNull)
bwPartNull_cmd_val = self._cmd_group.get_repcap_cmd_value(bwPartNull, repcap.BwPartNull)
allocationNull_cmd_val = self._cmd_group.get_repcap_cmd_value(allocationNull, repcap.AllocationNull)
return self._core.io.query_struct(f'SOURce<HwInstance>:BB:NR5G:SCHed:CELL{cellNull_cmd_val}:SUBF{subframeNull_cmd_val}:USER{userNull_cmd_val}:BWPart{bwPartNull_cmd_val}:ALLoc{allocationNull_cmd_val}:PDSCh:RESalloc:PATTern?', self.__class__.PatternStruct())