from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal import Conversions
from ........ import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class GainCls:
"""Gain commands group definition. 1 total commands, 0 Subgroups, 1 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("gain", core, parent)
[docs]
def set(self, gain: float, mimoTap=repcap.MimoTap.Default, ray=repcap.Ray.Default) -> None:
"""SCPI: [SOURce<HW>]:FSIMulator:MIMO:TAP<CH>:TGN:RAY<ST>:GAIN \n
Snippet: driver.source.fsimulator.mimo.tap.tgn.ray.gain.set(gain = 1.0, mimoTap = repcap.MimoTap.Default, ray = repcap.Ray.Default) \n
Sets the relative gain (in dB) of the selected ray. \n
:param gain: float Range: -50 to 0
:param mimoTap: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Tap')
:param ray: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Ray')
"""
param = Conversions.decimal_value_to_str(gain)
mimoTap_cmd_val = self._cmd_group.get_repcap_cmd_value(mimoTap, repcap.MimoTap)
ray_cmd_val = self._cmd_group.get_repcap_cmd_value(ray, repcap.Ray)
self._core.io.write(f'SOURce<HwInstance>:FSIMulator:MIMO:TAP{mimoTap_cmd_val}:TGN:RAY{ray_cmd_val}:GAIN {param}')
[docs]
def get(self, mimoTap=repcap.MimoTap.Default, ray=repcap.Ray.Default) -> float:
"""SCPI: [SOURce<HW>]:FSIMulator:MIMO:TAP<CH>:TGN:RAY<ST>:GAIN \n
Snippet: value: float = driver.source.fsimulator.mimo.tap.tgn.ray.gain.get(mimoTap = repcap.MimoTap.Default, ray = repcap.Ray.Default) \n
Sets the relative gain (in dB) of the selected ray. \n
:param mimoTap: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Tap')
:param ray: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Ray')
:return: gain: float Range: -50 to 0"""
mimoTap_cmd_val = self._cmd_group.get_repcap_cmd_value(mimoTap, repcap.MimoTap)
ray_cmd_val = self._cmd_group.get_repcap_cmd_value(ray, repcap.Ray)
response = self._core.io.query_str(f'SOURce<HwInstance>:FSIMulator:MIMO:TAP{mimoTap_cmd_val}:TGN:RAY{ray_cmd_val}:GAIN?')
return Conversions.str_to_float(response)