from ..........Internal.Core import Core
from ..........Internal.CommandsGroup import CommandsGroup
from ..........Internal import Conversions
from ..........Internal.RepeatedCapability import RepeatedCapability
from .......... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class CbIndexCls:
"""CbIndex commands group definition. 1 total commands, 0 Subgroups, 1 group commands
Repeated Capability: IndexNull, default value after init: IndexNull.Nr0"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("cbIndex", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_indexNull_get', 'repcap_indexNull_set', repcap.IndexNull.Nr0)
def repcap_indexNull_set(self, indexNull: repcap.IndexNull) -> None:
"""Repeated Capability default value numeric suffix.
This value is used, if you do not explicitely set it in the child set/get methods, or if you leave it to IndexNull.Default
Default value after init: IndexNull.Nr0"""
self._cmd_group.set_repcap_enum_value(indexNull)
def repcap_indexNull_get(self) -> repcap.IndexNull:
"""Returns the current default repeated capability for the child set/get methods"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
[docs] def set(self, code_book_index: int, subframeNull=repcap.SubframeNull.Default, allocationNull=repcap.AllocationNull.Default, codeword=repcap.Codeword.Default, indexNull=repcap.IndexNull.Default) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:[SUBF<ST0>]:ALLoc<CH0>:[CW<USER>]:PRECoding:CBINdex<DIR_OPTIONAL> \n
Snippet: driver.source.bb.eutra.downlink.subf.alloc.cw.precoding.cbIndex.set(code_book_index = 1, subframeNull = repcap.SubframeNull.Default, allocationNull = repcap.AllocationNull.Default, codeword = repcap.Codeword.Default, indexNull = repcap.IndexNull.Default) \n
Sets the codebook index for the selected allocation. The combination of codebook index and the selected number of layers
determines the codebook matrix used for precoding. \n
:param code_book_index: integer Range: 0 to 15
: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 indexNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'CbIndex')
"""
param = Conversions.decimal_value_to_str(code_book_index)
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)
indexNull_cmd_val = self._cmd_group.get_repcap_cmd_value(indexNull, repcap.IndexNull)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:DL:SUBF{subframeNull_cmd_val}:ALLoc{allocationNull_cmd_val}:CW{codeword_cmd_val}:PRECoding:CBINdex{indexNull_cmd_val} {param}')
[docs] def get(self, subframeNull=repcap.SubframeNull.Default, allocationNull=repcap.AllocationNull.Default, codeword=repcap.Codeword.Default, indexNull=repcap.IndexNull.Default) -> int:
"""SCPI: [SOURce<HW>]:BB:EUTRa:DL:[SUBF<ST0>]:ALLoc<CH0>:[CW<USER>]:PRECoding:CBINdex<DIR_OPTIONAL> \n
Snippet: value: int = driver.source.bb.eutra.downlink.subf.alloc.cw.precoding.cbIndex.get(subframeNull = repcap.SubframeNull.Default, allocationNull = repcap.AllocationNull.Default, codeword = repcap.Codeword.Default, indexNull = repcap.IndexNull.Default) \n
Sets the codebook index for the selected allocation. The combination of codebook index and the selected number of layers
determines the codebook matrix used for precoding. \n
: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 indexNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'CbIndex')
:return: code_book_index: integer Range: 0 to 15"""
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)
indexNull_cmd_val = self._cmd_group.get_repcap_cmd_value(indexNull, repcap.IndexNull)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:EUTRa:DL:SUBF{subframeNull_cmd_val}:ALLoc{allocationNull_cmd_val}:CW{codeword_cmd_val}:PRECoding:CBINdex{indexNull_cmd_val}?')
return Conversions.str_to_int(response)
def clone(self) -> 'CbIndexCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = CbIndexCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group