Source code for RsSmw.Implementations.Source.Bb.Pramp.Ramp.PreSweep

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


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PreSweepCls:
	"""
	| Commands in total: 3
	| Subgroups: 0
	| Direct child commands: 3
	"""

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

[docs] def get_state(self) -> bool: """ ``[SOURce<HW>]:BB:PRAMp:RAMP:PRESweep:STATe`` \n Snippet: ``value: bool = driver.source.bb.pramp.ramp.preSweep.get_state()`` \n Activates the pre-sweep. To determine the pre-sweep power, use method ``RsSmw.source.bb.pramp.ramp.preSweep.level()`` . :return: enable_pre_sweep: 1 | ON | 0| OFF """ response = self._core.io.query_str('SOURce<HwInstance>:BB:PRAMp:RAMP:PRESweep:STATe?') return Conversions.str_to_bool(response)
[docs] def set_state(self, enable_pre_sweep: bool) -> None: """ ``[SOURce<HW>]:BB:PRAMp:RAMP:PRESweep:STATe`` \n Snippet: ``driver.source.bb.pramp.ramp.preSweep.set_state(enable_pre_sweep = False)`` \n Activates the pre-sweep. To determine the pre-sweep power, use method ``RsSmw.source.bb.pramp.ramp.preSweep.level()`` . :param enable_pre_sweep: 1 | ON | 0| OFF """ param = Conversions.bool_to_str(enable_pre_sweep) self._core.io.write(f'SOURce<HwInstance>:BB:PRAMp:RAMP:PRESweep:STATe {param}')
[docs] def get_time(self) -> float: """ ``[SOURce<HW>]:BB:PRAMp:RAMP:PRESweep:TIME`` \n Snippet: ``value: float = driver.source.bb.pramp.ramp.preSweep.get_time()`` \n Queries the calculated pre-sweep time. :return: pre_sweep_time: float Range: 0 to 20 """ response = self._core.io.query_str('SOURce<HwInstance>:BB:PRAMp:RAMP:PRESweep:TIME?') return Conversions.str_to_float(response)
[docs] def set_time(self, pre_sweep_time: float) -> None: """ ``[SOURce<HW>]:BB:PRAMp:RAMP:PRESweep:TIME`` \n Snippet: ``driver.source.bb.pramp.ramp.preSweep.set_time(pre_sweep_time = 1.0)`` \n Queries the calculated pre-sweep time. :param pre_sweep_time: float Range: 0 to 20 """ param = Conversions.decimal_value_to_str(pre_sweep_time) self._core.io.write(f'SOURce<HwInstance>:BB:PRAMp:RAMP:PRESweep:TIME {param}')
[docs] def get_level(self) -> float: """ ``[SOURce<HW>]:BB:PRAMp:RAMP:PRESweep:[LEVel]`` \n Snippet: ``value: float = driver.source.bb.pramp.ramp.preSweep.get_level()`` \n Sets the pre-sweep power. To activate pre-sweep, use method ``RsSmw.source.bb.pramp.ramp.preSweep.state()`` . :return: pre_sweep_level: float Range: 0 to 20, Unit: dB """ response = self._core.io.query_str('SOURce<HwInstance>:BB:PRAMp:RAMP:PRESweep:LEVel?') return Conversions.str_to_float(response)
[docs] def set_level(self, pre_sweep_level: float) -> None: """ ``[SOURce<HW>]:BB:PRAMp:RAMP:PRESweep:[LEVel]`` \n Snippet: ``driver.source.bb.pramp.ramp.preSweep.set_level(pre_sweep_level = 1.0)`` \n Sets the pre-sweep power. To activate pre-sweep, use method ``RsSmw.source.bb.pramp.ramp.preSweep.state()`` . :param pre_sweep_level: float Range: 0 to 20, Unit: dB """ param = Conversions.decimal_value_to_str(pre_sweep_level) self._core.io.write(f'SOURce<HwInstance>:BB:PRAMp:RAMP:PRESweep:LEVel {param}')