from .............Internal.Core import Core
from .............Internal.CommandsGroup import CommandsGroup
from .............Internal import Conversions
from ............. import enums
from ............. import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class UsageCls:
"""Usage commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("usage", core, parent)
[docs] def set(self, usage: enums.AllocDciUsage, cellNull=repcap.CellNull.Default, subframeNull=repcap.SubframeNull.Default, userNull=repcap.UserNull.Default, bwPartNull=repcap.BwPartNull.Default, allocationNull=repcap.AllocationNull.Default, indexNull=repcap.IndexNull.Default) -> None:
"""SCPI: [SOURce<HW>]:BB:NR5G:SCHed:CELL<CC(CH0)>:SUBF<SF(ST0)>:USER<US(DIR0)>:BWPart<BWP(GR0)>:ALLoc<AL(USER0)>:CS:DCI<DCI(S2US0)>:USAGe \n
Snippet: driver.source.bb.nr5G.scheduling.cell.subf.user.bwPart.alloc.cs.dci.usage.set(usage = enums.AllocDciUsage.AI, cellNull = repcap.CellNull.Default, subframeNull = repcap.SubframeNull.Default, userNull = repcap.UserNull.Default, bwPartNull = repcap.BwPartNull.Default, allocationNull = repcap.AllocationNull.Default, indexNull = repcap.IndexNull.Default) \n
Sets the RNTI type used to scramble the CRC. \n
:param usage: The RNTI type is defined as follows: C Cell RNTI CS Configured scheduling RNTI P Paging RNTI SI System information RNTI RA Random access RNTI TC Temporary cell RNTI SPCS Semi-persistent scheduling cell RNTI SFI Slot format indication RNTI INT Interruption RNTI TPUS Transmit power control-PUSCH RNTI TPUC Transmit power control-PUCCH RNTI TSRS Transmit power control-SRS RNTI MCSC Modulation coding scheme cell RNTI CI Cancellation indication RNTI PS Power saving RNTI AI Availability indication RNTI MSGB MsgB RNTI CUSTom Custom DCI format
: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 indexNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Dci')
"""
param = Conversions.enum_scalar_to_str(usage, enums.AllocDciUsage)
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)
indexNull_cmd_val = self._cmd_group.get_repcap_cmd_value(indexNull, repcap.IndexNull)
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}:CS:DCI{indexNull_cmd_val}:USAGe {param}')
# noinspection PyTypeChecker
[docs] def get(self, cellNull=repcap.CellNull.Default, subframeNull=repcap.SubframeNull.Default, userNull=repcap.UserNull.Default, bwPartNull=repcap.BwPartNull.Default, allocationNull=repcap.AllocationNull.Default, indexNull=repcap.IndexNull.Default) -> enums.AllocDciUsage:
"""SCPI: [SOURce<HW>]:BB:NR5G:SCHed:CELL<CC(CH0)>:SUBF<SF(ST0)>:USER<US(DIR0)>:BWPart<BWP(GR0)>:ALLoc<AL(USER0)>:CS:DCI<DCI(S2US0)>:USAGe \n
Snippet: value: enums.AllocDciUsage = driver.source.bb.nr5G.scheduling.cell.subf.user.bwPart.alloc.cs.dci.usage.get(cellNull = repcap.CellNull.Default, subframeNull = repcap.SubframeNull.Default, userNull = repcap.UserNull.Default, bwPartNull = repcap.BwPartNull.Default, allocationNull = repcap.AllocationNull.Default, indexNull = repcap.IndexNull.Default) \n
Sets the RNTI type used to scramble the CRC. \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')
:param indexNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Dci')
:return: usage: The RNTI type is defined as follows: C Cell RNTI CS Configured scheduling RNTI P Paging RNTI SI System information RNTI RA Random access RNTI TC Temporary cell RNTI SPCS Semi-persistent scheduling cell RNTI SFI Slot format indication RNTI INT Interruption RNTI TPUS Transmit power control-PUSCH RNTI TPUC Transmit power control-PUCCH RNTI TSRS Transmit power control-SRS RNTI MCSC Modulation coding scheme cell RNTI CI Cancellation indication RNTI PS Power saving RNTI AI Availability indication RNTI MSGB MsgB RNTI CUSTom Custom DCI format"""
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)
indexNull_cmd_val = self._cmd_group.get_repcap_cmd_value(indexNull, repcap.IndexNull)
response = self._core.io.query_str(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}:CS:DCI{indexNull_cmd_val}:USAGe?')
return Conversions.str_to_scalar_enum(response, enums.AllocDciUsage)