Source code for RsFsw.Implementations.Calculate.Limit.Lower.Margin

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


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

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

[docs] def set(self, margin: float, window=repcap.Window.Default, limitIx=repcap.LimitIx.Default) -> None: """ ``CALCulate<n>:LIMit<li>:LOWer:MARGin`` \n Snippet: ``driver.calculate.limit.lower.margin.set(margin = 1.0, window = repcap.Window.Default, limitIx = repcap.LimitIx.Default)`` \n Defines an area around a lower limit line where limit check violations are still tolerated. :param margin: numeric value Unit: dB :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate') :param limitIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit') """ param = Conversions.decimal_value_to_str(margin) window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) limitIx_cmd_val = self._cmd_group.get_repcap_cmd_value(limitIx, repcap.LimitIx) self._core.io.write(f'CALCulate{window_cmd_val}:LIMit{limitIx_cmd_val}:LOWer:MARGin {param}')
[docs] def get(self, window=repcap.Window.Default, limitIx=repcap.LimitIx.Default) -> float: """ ``CALCulate<n>:LIMit<li>:LOWer:MARGin`` \n Snippet: ``value: float = driver.calculate.limit.lower.margin.get(window = repcap.Window.Default, limitIx = repcap.LimitIx.Default)`` \n Defines an area around a lower limit line where limit check violations are still tolerated. :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate') :param limitIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Limit') :return: margin: numeric value Unit: dB """ window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) limitIx_cmd_val = self._cmd_group.get_repcap_cmd_value(limitIx, repcap.LimitIx) response = self._core.io.query_str(f'CALCulate{window_cmd_val}:LIMit{limitIx_cmd_val}:LOWer:MARGin?') return Conversions.str_to_float(response)