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 BpayloadCls:
"""Bpayload 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("bpayload", 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 get(self, baseStation=repcap.BaseStation.Default, channelNull=repcap.ChannelNull.Default, indexNull=repcap.IndexNull.Default) -> float:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation<ST>:CHANnel<CH0>:HSDPa:HSET:BPAYload<DI> \n
Snippet: value: float = driver.source.bb.w3Gpp.bstation.channel.hsdpa.hset.bpayload.get(baseStation = repcap.BaseStation.Default, channelNull = repcap.ChannelNull.Default, indexNull = repcap.IndexNull.Default) \n
The command queries the payload of the information bit. This value determines the number of transport layer bits sent in
each subframe. \n
: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 indexNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Bpayload')
:return: bpayload: float Range: 1 to 5000"""
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)
indexNull_cmd_val = self._cmd_group.get_repcap_cmd_value(indexNull, repcap.IndexNull)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:W3GPp:BSTation{baseStation_cmd_val}:CHANnel{channelNull_cmd_val}:HSDPa:HSET:BPAYload{indexNull_cmd_val}?')
return Conversions.str_to_float(response)
def clone(self) -> 'BpayloadCls':
"""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 = BpayloadCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group