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
class SaPatternCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("saPattern", core, parent)
[docs]
def set(self, sa_pattern: str, baseStation=repcap.BaseStation.Default, channelNull=repcap.ChannelNull.Default) -> None:
"""
``[SOURce<HW>]:BB:W3GPp:BSTation<ST>:CHANnel<CH0>:APAIch:SAPattern`` \n
Snippet: ``driver.source.bb.w3Gpp.bstation.channel.apaich.saPattern.set(sa_pattern = 'abc', baseStation = repcap.BaseStation.Default, channelNull = repcap.ChannelNull.Default)`` \n
Enters the 16-bit pattern for the ACK/NACK field. This field is used by the base station to acknowledge, refuse or ignore
requests of up to 16 user equipment.
:param sa_pattern: 16 bit pattern
:param baseStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bstation')
:param channelNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Channel')
"""
param = Conversions.value_to_quoted_str(sa_pattern)
baseStation_cmd_val = self._cmd_group.get_repcap_cmd_value(baseStation, repcap.BaseStation)
channelNull_cmd_val = self._cmd_group.get_repcap_cmd_value(channelNull, repcap.ChannelNull)
self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:BSTation{baseStation_cmd_val}:CHANnel{channelNull_cmd_val}:APAIch:SAPattern {param}')
[docs]
def get(self, baseStation=repcap.BaseStation.Default, channelNull=repcap.ChannelNull.Default) -> str:
"""
``[SOURce<HW>]:BB:W3GPp:BSTation<ST>:CHANnel<CH0>:APAIch:SAPattern`` \n
Snippet: ``value: str = driver.source.bb.w3Gpp.bstation.channel.apaich.saPattern.get(baseStation = repcap.BaseStation.Default, channelNull = repcap.ChannelNull.Default)`` \n
Enters the 16-bit pattern for the ACK/NACK field. This field is used by the base station to acknowledge, refuse or ignore
requests of up to 16 user equipment.
:param baseStation: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bstation')
:param channelNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Channel')
:return: sa_pattern: 16 bit pattern
"""
baseStation_cmd_val = self._cmd_group.get_repcap_cmd_value(baseStation, repcap.BaseStation)
channelNull_cmd_val = self._cmd_group.get_repcap_cmd_value(channelNull, repcap.ChannelNull)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:W3GPp:BSTation{baseStation_cmd_val}:CHANnel{channelNull_cmd_val}:APAIch:SAPattern?')
return trim_str_response(response)