Source code for RsFsw.Implementations.Calculate.Marker.Function.NdbDown.Result

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


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

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

[docs] def get(self, window=repcap.Window.Default, marker=repcap.Marker.Default) -> float: """ ``CALCulate<n>:MARKer<m>:FUNCtion:NDBDown:RESult`` \n Snippet: ``value: float = driver.calculate.marker.function.ndbDown.result.get(window = repcap.Window.Default, marker = repcap.Marker.Default)`` \n Queries the distance of the n dB down markers from each other. To get a valid result, you have to perform a complete measurement with synchronization to the end of the measurement before reading out the result. This is only possible for single sweep mode. See also method ``RsFsw.applications.k10Xlte.initiate.continuous.set()`` . :param window: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Calculate') :param marker: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Marker') :return: distance: The result depends on the span. In case of frequency domain measurements, the command returns the bandwidth between the two n dB down markers in Hz. In case of time domain measurements, the command returns the pulse width between the two n dB down markers in seconds. """ window_cmd_val = self._cmd_group.get_repcap_cmd_value(window, repcap.Window) marker_cmd_val = self._cmd_group.get_repcap_cmd_value(marker, repcap.Marker) response = self._core.io.query_str(f'CALCulate{window_cmd_val}:MARKer{marker_cmd_val}:FUNCtion:NDBDown:RESult?') return Conversions.str_to_float(response)