from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ConGainCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("conGain", core, parent)
[docs]
def set(self, conversion_gain: float, probe=repcap.Probe.Default) -> None:
"""
``PROBe<*>:SETup:OPTical:CONGain`` \n
Snippet: ``driver.probe.setup.optical.conGain.set(conversion_gain = 1.0, probe = repcap.Probe.Default)`` \n
Returns or sets the conversion gain, depending on method ``RsRtx.probe.setup.optical.wavLength.set()`` . The setting is
relevant for optic receivers and probes.
:param conversion_gain: -1000 to -1
:param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Probe')
"""
param = Conversions.decimal_value_to_str(conversion_gain)
probe_cmd_val = self._cmd_group.get_repcap_cmd_value(probe, repcap.Probe)
self._core.io.write_with_opc(f'PROBe{probe_cmd_val}:SETup:OPTical:CONGain {param}')
[docs]
def get(self, probe=repcap.Probe.Default) -> float:
"""
``PROBe<*>:SETup:OPTical:CONGain`` \n
Snippet: ``value: float = driver.probe.setup.optical.conGain.get(probe = repcap.Probe.Default)`` \n
Returns or sets the conversion gain, depending on method ``RsRtx.probe.setup.optical.wavLength.set()`` . The setting is
relevant for optic receivers and probes.
:param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Probe')
:return: conversion_gain: -1000 to -1
"""
probe_cmd_val = self._cmd_group.get_repcap_cmd_value(probe, repcap.Probe)
response = self._core.io.query_str_with_opc(f'PROBe{probe_cmd_val}:SETup:OPTical:CONGain?')
return Conversions.str_to_float(response)