from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal import Conversions
from ........Internal.Utilities import trim_str_response
from ........ import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class LcMaskCls:
"""LcMask commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("lcMask", core, parent)
[docs] def set(self, lc_mask: str, baseStation=repcap.BaseStation.Default, groupNull=repcap.GroupNull.Default, offset=repcap.Offset.Default) -> None:
"""SCPI: [SOURce<HW>]:BB:C2K:BSTation<ST>:CGRoup<DI0>:COFFset<CH>:LCMask \n
Snippet: driver.source.bb.c2K.bstation.cgroup.coffset.lcMask.set(lc_mask = rawAbc, baseStation = repcap.BaseStation.Default, groupNull = repcap.GroupNull.Default, offset = repcap.Offset.Default) \n
The command sets the mask of the Long Code Generator of the base station. For the traffic channels, this value is
specific for the selected radio configuration. The LC Mask is the same for all sub channels of a traffic channel. If the
mask is modified for one of the sub channels, the new value is then automatically used by all other subchannels of this
traffic channel. \n
:param lc_mask: integer Range: #H0 to #H3FF FFFF FFFF
:param baseStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bstation')
:param groupNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cgroup')
:param offset: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Coffset')
"""
param = Conversions.value_to_str(lc_mask)
baseStation_cmd_val = self._cmd_group.get_repcap_cmd_value(baseStation, repcap.BaseStation)
groupNull_cmd_val = self._cmd_group.get_repcap_cmd_value(groupNull, repcap.GroupNull)
offset_cmd_val = self._cmd_group.get_repcap_cmd_value(offset, repcap.Offset)
self._core.io.write(f'SOURce<HwInstance>:BB:C2K:BSTation{baseStation_cmd_val}:CGRoup{groupNull_cmd_val}:COFFset{offset_cmd_val}:LCMask {param}')
[docs] def get(self, baseStation=repcap.BaseStation.Default, groupNull=repcap.GroupNull.Default, offset=repcap.Offset.Default) -> str:
"""SCPI: [SOURce<HW>]:BB:C2K:BSTation<ST>:CGRoup<DI0>:COFFset<CH>:LCMask \n
Snippet: value: str = driver.source.bb.c2K.bstation.cgroup.coffset.lcMask.get(baseStation = repcap.BaseStation.Default, groupNull = repcap.GroupNull.Default, offset = repcap.Offset.Default) \n
The command sets the mask of the Long Code Generator of the base station. For the traffic channels, this value is
specific for the selected radio configuration. The LC Mask is the same for all sub channels of a traffic channel. If the
mask is modified for one of the sub channels, the new value is then automatically used by all other subchannels of this
traffic channel. \n
:param baseStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bstation')
:param groupNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Cgroup')
:param offset: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Coffset')
:return: lc_mask: integer Range: #H0 to #H3FF FFFF FFFF"""
baseStation_cmd_val = self._cmd_group.get_repcap_cmd_value(baseStation, repcap.BaseStation)
groupNull_cmd_val = self._cmd_group.get_repcap_cmd_value(groupNull, repcap.GroupNull)
offset_cmd_val = self._cmd_group.get_repcap_cmd_value(offset, repcap.Offset)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:C2K:BSTation{baseStation_cmd_val}:CGRoup{groupNull_cmd_val}:COFFset{offset_cmd_val}:LCMask?')
return trim_str_response(response)