Source code for rsmxo.Implementations.Power.Efficiency.Total.Opower.Vertical.Offset

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


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

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

[docs] def set(self, vertical_offset: float, power=repcap.Power.Default) -> None: """ ``POWer<*>:EFFiciency:TOTal:OPOWer:VERTical:OFFSet`` \n Snippet: ``driver.power.efficiency.total.opower.vertical.offset.set(vertical_offset = 1.0, power = repcap.Power.Default)`` \n Sets the vertical offset of the power waveform if the relevant POWer<m>:{SUBSYS}:POWer:VERTical:SCALe:MODE command is set to MANual. :param vertical_offset: -100000000000000 to 100000000000000 :param power: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Power') """ param = Conversions.decimal_value_to_str(vertical_offset) power_cmd_val = self._cmd_group.get_repcap_cmd_value(power, repcap.Power) self._core.io.write(f'POWer{power_cmd_val}:EFFiciency:TOTal:OPOWer:VERTical:OFFSet {param}')
[docs] def get(self, power=repcap.Power.Default) -> float: """ ``POWer<*>:EFFiciency:TOTal:OPOWer:VERTical:OFFSet`` \n Snippet: ``value: float = driver.power.efficiency.total.opower.vertical.offset.get(power = repcap.Power.Default)`` \n Sets the vertical offset of the power waveform if the relevant POWer<m>:{SUBSYS}:POWer:VERTical:SCALe:MODE command is set to MANual. :param power: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Power') :return: vertical_offset: -100000000000000 to 100000000000000 """ power_cmd_val = self._cmd_group.get_repcap_cmd_value(power, repcap.Power) response = self._core.io.query_str(f'POWer{power_cmd_val}:EFFiciency:TOTal:OPOWer:VERTical:OFFSet?') return Conversions.str_to_float(response)