from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal import Conversions
from ........ import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
[docs]
def get(self, userIx=repcap.UserIx.Default) -> bool:
"""
``[SOURce<HW>]:BB:ONEWeb:DL:USER<CH>:SCRambling:STATe`` \n
Snippet: ``value: bool = driver.source.bb.oneweb.downlink.user.scrambling.state.get(userIx = repcap.UserIx.Default)`` \n
Queries the scrambling state for all allocations belonging to the selected user.
:param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
:return: state: 1 | ON | 0| OFF
"""
userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:ONEWeb:DL:USER{userIx_cmd_val}:SCRambling:STATe?')
return Conversions.str_to_bool(response)