from ..........Internal.Core import Core
from ..........Internal.CommandsGroup import CommandsGroup
from ..........Internal import Conversions
from .......... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class RuIndexCls:
"""RuIndex commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("ruIndex", core, parent)
[docs] def set(self, index: float, segment=repcap.Segment.Default, channel=repcap.Channel.Default, ruAllocationIx=repcap.RuAllocationIx.Default) -> None:
"""SCPI: CONFigure:WLAN:RUConfig:SEGMent<seg>:CHANnel<ch>:RULocation<cf>:RUINdex \n
Snippet: driver.applications.k91Wlan.configure.wlan.ruConfig.segment.channel.rulocation.ruIndex.set(index = 1.0, segment = repcap.Segment.Default, channel = repcap.Channel.Default, ruAllocationIx = repcap.RuAllocationIx.Default) \n
Sets or queries the index of the resource unit as defined by the IEEE 802.11ax, be standard (based on resource units of
the specified RU size, see method RsFsw.Applications.K91_Wlan.Configure.Wlan.RuConfig.Segment.Channel.Rulocation.RuSize.
set) . This value determines the position of the resource unit within the channel. Note that you can specify any possible
RU index value for the entire channel, regardless of the specified segment and subchannel. To determine the highest
allocated RU index for a specific segment and subchannel, use method RsFsw.Applications.K91_Wlan.Configure.Wlan.RuConfig.
Segment.Channel.Rulocation.Count.Highest.get_. To determine the highest allocated RU index for the entire channel, see
method RsFsw.Applications.K91_Wlan.Configure.Wlan.RuConfig.Count.Highest.get_. \n
:param index: integer RU index Range: 1 to 144
:param segment: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Segment')
:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
:param ruAllocationIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Rulocation')
"""
param = Conversions.decimal_value_to_str(index)
segment_cmd_val = self._cmd_group.get_repcap_cmd_value(segment, repcap.Segment)
channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel)
ruAllocationIx_cmd_val = self._cmd_group.get_repcap_cmd_value(ruAllocationIx, repcap.RuAllocationIx)
self._core.io.write(f'CONFigure:WLAN:RUConfig:SEGMent{segment_cmd_val}:CHANnel{channel_cmd_val}:RULocation{ruAllocationIx_cmd_val}:RUINdex {param}')
[docs] def get(self, segment=repcap.Segment.Default, channel=repcap.Channel.Default, ruAllocationIx=repcap.RuAllocationIx.Default) -> float:
"""SCPI: CONFigure:WLAN:RUConfig:SEGMent<seg>:CHANnel<ch>:RULocation<cf>:RUINdex \n
Snippet: value: float = driver.applications.k91Wlan.configure.wlan.ruConfig.segment.channel.rulocation.ruIndex.get(segment = repcap.Segment.Default, channel = repcap.Channel.Default, ruAllocationIx = repcap.RuAllocationIx.Default) \n
Sets or queries the index of the resource unit as defined by the IEEE 802.11ax, be standard (based on resource units of
the specified RU size, see method RsFsw.Applications.K91_Wlan.Configure.Wlan.RuConfig.Segment.Channel.Rulocation.RuSize.
set) . This value determines the position of the resource unit within the channel. Note that you can specify any possible
RU index value for the entire channel, regardless of the specified segment and subchannel. To determine the highest
allocated RU index for a specific segment and subchannel, use method RsFsw.Applications.K91_Wlan.Configure.Wlan.RuConfig.
Segment.Channel.Rulocation.Count.Highest.get_. To determine the highest allocated RU index for the entire channel, see
method RsFsw.Applications.K91_Wlan.Configure.Wlan.RuConfig.Count.Highest.get_. \n
:param segment: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Segment')
:param channel: optional repeated capability selector. Default value: Ch1 (settable in the interface 'Channel')
:param ruAllocationIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Rulocation')
:return: index: integer RU index Range: 1 to 144"""
segment_cmd_val = self._cmd_group.get_repcap_cmd_value(segment, repcap.Segment)
channel_cmd_val = self._cmd_group.get_repcap_cmd_value(channel, repcap.Channel)
ruAllocationIx_cmd_val = self._cmd_group.get_repcap_cmd_value(ruAllocationIx, repcap.RuAllocationIx)
response = self._core.io.query_str(f'CONFigure:WLAN:RUConfig:SEGMent{segment_cmd_val}:CHANnel{channel_cmd_val}:RULocation{ruAllocationIx_cmd_val}:RUINdex?')
return Conversions.str_to_float(response)