from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from ....... import enums
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class UpPatternCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("upPattern", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, channelNull=repcap.ChannelNull.Default) -> enums.BtoCsPyLdPatt:
"""
``[SOURce<HW>]:BB:BTOoth:CS:[SEVent<CH0>]:UPPattern`` \n
Snippet: ``value: enums.BtoCsPyLdPatt = driver.source.bb.btooth.cs.sevent.upPattern.get(channelNull = repcap.ChannelNull.Default)`` \n
Selects the user payload pattern for a random CS sequence. This pattern is the payload type for CS step configuration
modes Mode-1 or Mode-3.
:param channelNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Sevent')
:return: pattern: PRBS09 | RE1S | RE2S | PRBS15 | RE3S | RE4S | RE5S | RE6S | UPLD PRBS09 | PRBS15 Pseudo random bit sequence with 9-bit length or 15-bit length in accordance with the IUT-T. RE1S | RE2S | RE3S | RE4S | RE5S | RE6S Repeated 8-digit sequences of zeroes and ones. UPLD Uses the CS_SYNC_User_Payload. Set this payload via a data list file and the following command: :SOURce1:BB:BTOoth:CS:SEVentch0:UPAYload See also method ``RsSmw.source.bb.btooth.cs.sevent.upayload.get()`` .
"""
channelNull_cmd_val = self._cmd_group.get_repcap_cmd_value(channelNull, repcap.ChannelNull)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:BTOoth:CS:SEVent{channelNull_cmd_val}:UPPattern?')
return Conversions.str_to_scalar_enum(response, enums.BtoCsPyLdPatt)