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 ScpiRatioCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("scpiRatio", core, parent)
[docs]
def set(self, scpi_ratio: enums.GsmBursPowerRatio, frameIx=repcap.FrameIx.Default, slotNull=repcap.SlotNull.Default, subChannel=repcap.SubChannel.Default, userIx=repcap.UserIx.Default) -> None:
"""
``[SOURce<HW>]:BB:GSM:[FRAMe<DI>]:SLOT<ST0>:[SUBChannel<US>]:[USER<CH>]:SCPIRatio`` \n
Snippet: ``driver.source.bb.gsm.frame.slot.subChannel.user.scpiRatio.set(scpi_ratio = enums.GsmBursPowerRatio.SCPIR0, frameIx = repcap.FrameIx.Default, slotNull = repcap.SlotNull.Default, subChannel = repcap.SubChannel.Default, userIx = repcap.UserIx.Default)`` \n
The command selects one of eight possible values for the SCPIR. The eight possible values are set using the command
[:SOURce<hw>]:BB:GSM:AQPSk:SCPIR<ch0>.
:param scpi_ratio: SCPIR7 | SCPIR6 | SCPIR5 | SCPIR4 | SCPIR3 | SCPIR2 | SCPIR1 | SCPIR0
:param frameIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Frame')
:param slotNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Slot')
:param subChannel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'SubChannel')
:param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
"""
param = Conversions.enum_scalar_to_str(scpi_ratio, enums.GsmBursPowerRatio)
frameIx_cmd_val = self._cmd_group.get_repcap_cmd_value(frameIx, repcap.FrameIx)
slotNull_cmd_val = self._cmd_group.get_repcap_cmd_value(slotNull, repcap.SlotNull)
subChannel_cmd_val = self._cmd_group.get_repcap_cmd_value(subChannel, repcap.SubChannel)
userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx)
self._core.io.write(f'SOURce<HwInstance>:BB:GSM:FRAMe{frameIx_cmd_val}:SLOT{slotNull_cmd_val}:SUBChannel{subChannel_cmd_val}:USER{userIx_cmd_val}:SCPIRatio {param}')
# noinspection PyTypeChecker
[docs]
def get(self, frameIx=repcap.FrameIx.Default, slotNull=repcap.SlotNull.Default, subChannel=repcap.SubChannel.Default, userIx=repcap.UserIx.Default) -> enums.GsmBursPowerRatio:
"""
``[SOURce<HW>]:BB:GSM:[FRAMe<DI>]:SLOT<ST0>:[SUBChannel<US>]:[USER<CH>]:SCPIRatio`` \n
Snippet: ``value: enums.GsmBursPowerRatio = driver.source.bb.gsm.frame.slot.subChannel.user.scpiRatio.get(frameIx = repcap.FrameIx.Default, slotNull = repcap.SlotNull.Default, subChannel = repcap.SubChannel.Default, userIx = repcap.UserIx.Default)`` \n
The command selects one of eight possible values for the SCPIR. The eight possible values are set using the command
[:SOURce<hw>]:BB:GSM:AQPSk:SCPIR<ch0>.
:param frameIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Frame')
:param slotNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Slot')
:param subChannel: optional repeated capability selector. Default value: Nr1 (settable in the interface 'SubChannel')
:param userIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'User')
:return: scpi_ratio: SCPIR7 | SCPIR6 | SCPIR5 | SCPIR4 | SCPIR3 | SCPIR2 | SCPIR1 | SCPIR0
"""
frameIx_cmd_val = self._cmd_group.get_repcap_cmd_value(frameIx, repcap.FrameIx)
slotNull_cmd_val = self._cmd_group.get_repcap_cmd_value(slotNull, repcap.SlotNull)
subChannel_cmd_val = self._cmd_group.get_repcap_cmd_value(subChannel, repcap.SubChannel)
userIx_cmd_val = self._cmd_group.get_repcap_cmd_value(userIx, repcap.UserIx)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:GSM:FRAMe{frameIx_cmd_val}:SLOT{slotNull_cmd_val}:SUBChannel{subChannel_cmd_val}:USER{userIx_cmd_val}:SCPIRatio?')
return Conversions.str_to_scalar_enum(response, enums.GsmBursPowerRatio)