from .........Internal.Core import Core
from .........Internal.CommandsGroup import CommandsGroup
from .........Internal import Conversions
from ......... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class StateCls:
"""State commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
[docs] def set(self, state: bool, baseStation=repcap.BaseStation.Default, channelNull=repcap.ChannelNull.Default) -> None:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation<ST>:CHANnel<CH0>:DPCCh:TFCI:STATe \n
Snippet: driver.source.bb.w3Gpp.bstation.channel.dpcch.tfci.state.set(state = False, baseStation = repcap.BaseStation.Default, channelNull = repcap.ChannelNull.Default) \n
The command activates the TFCI field (Transport Format Combination Identifier) for the selected channel of the specified
base station. The slot format determines the symbol rate (and thus the range of values for the channelization code) , the
TFCI state and the pilot length. If the value of any one of the four parameters is changed, all the other parameters are
adapted as necessary. In the case of enhanced channels with active channel coding, the selected channel coding also
affects the slot format and thus the remaining parameters. If these parameters are changed, the channel coding type is
set to user. \n
:param state: ON| OFF
: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.bool_to_str(state)
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}:DPCCh:TFCI:STATe {param}')
[docs] def get(self, baseStation=repcap.BaseStation.Default, channelNull=repcap.ChannelNull.Default) -> bool:
"""SCPI: [SOURce<HW>]:BB:W3GPp:BSTation<ST>:CHANnel<CH0>:DPCCh:TFCI:STATe \n
Snippet: value: bool = driver.source.bb.w3Gpp.bstation.channel.dpcch.tfci.state.get(baseStation = repcap.BaseStation.Default, channelNull = repcap.ChannelNull.Default) \n
The command activates the TFCI field (Transport Format Combination Identifier) for the selected channel of the specified
base station. The slot format determines the symbol rate (and thus the range of values for the channelization code) , the
TFCI state and the pilot length. If the value of any one of the four parameters is changed, all the other parameters are
adapted as necessary. In the case of enhanced channels with active channel coding, the selected channel coding also
affects the slot format and thus the remaining parameters. If these parameters are changed, the channel coding type is
set to user. \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')
:return: state: ON| OFF"""
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}:DPCCh:TFCI:STATe?')
return Conversions.str_to_bool(response)