Source code for RsAreg800.Implementations.Source.AreGenerator.Channel.InputPy

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection

[docs]
class InputPyCls:
	"""InputPy commands group definition. 2 total commands, 0 Subgroups, 2 group commands"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("inputPy", core, parent)


[docs]
	def get_nom_gain(self) -> float:
		"""SCPI: [SOURce<HW>]:AREGenerator:CHANnel:INPut:NOMGain \n
		Snippet: value: float = driver.source.areGenerator.channel.inputPy.get_nom_gain() \n
		Sets a value to adjust the input gain of the channel manually. The R&S AREG800A sets the nominal input gain automatically
		by using the [:SOURce<hw>]:AREGenerator:MAPPing<ch>:ADJust:LEVel function in the channel mapping. You can set the input
		gain manually, for example to restore the value. \n
			:return: areg_chan_nom_gain: float Range: -50 to 35
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:AREGenerator:CHANnel:INPut:NOMGain?')
		return Conversions.str_to_float(response)



[docs]
	def set_nom_gain(self, areg_chan_nom_gain: float) -> None:
		"""SCPI: [SOURce<HW>]:AREGenerator:CHANnel:INPut:NOMGain \n
		Snippet: driver.source.areGenerator.channel.inputPy.set_nom_gain(areg_chan_nom_gain = 1.0) \n
		Sets a value to adjust the input gain of the channel manually. The R&S AREG800A sets the nominal input gain automatically
		by using the [:SOURce<hw>]:AREGenerator:MAPPing<ch>:ADJust:LEVel function in the channel mapping. You can set the input
		gain manually, for example to restore the value. \n
			:param areg_chan_nom_gain: float Range: -50 to 35
		"""
		param = Conversions.decimal_value_to_str(areg_chan_nom_gain)
		self._core.io.write(f'SOURce<HwInstance>:AREGenerator:CHANnel:INPut:NOMGain {param}')



[docs]
	def get_rel_level(self) -> float:
		"""SCPI: [SOURce<HW>]:AREGenerator:CHANnel:INPut:RELLevel \n
		Snippet: value: float = driver.source.areGenerator.channel.inputPy.get_rel_level() \n
		Queries the actual input level of the analog to digital converter of the R&S AREG800A in relation to full scale.
		This value is the maximum measured during the defined [:SOURce<hw>]:AREGenerator:MAPPing<ch>:ADJust:LEVel:OTIMe
		(observation time for peak detection) . If the value is not steady enough, we recommend prolonging the observation time. \n
			:return: areg_chan_rel_lev: float Range: -50 to 35
		"""
		response = self._core.io.query_str('SOURce<HwInstance>:AREGenerator:CHANnel:INPut:RELLevel?')
		return Conversions.str_to_float(response)