Source code for rsrtx.Implementations.Search.Result.Cmsb.Frame.Stop

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


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

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

[docs] def get(self, search: str, searchResCmsb=repcap.SearchResCmsb.Default, busFrameNull=repcap.BusFrameNull.Default) -> float: """ ``SEARch:RESult:CMSB<*>:FRAMe<*>:STOP`` \n Snippet: ``value: float = driver.search.result.cmsb.frame.stop.get(search = 'abc', searchResCmsb = repcap.SearchResCmsb.Default, busFrameNull = repcap.BusFrameNull.Default)`` \n Returns the stop time of the frame within the search result. :param searchResCmsb: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cmsb') :param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame') :return: stop: -100E+24 to 100E+24 """ param = Conversions.value_to_quoted_str(search) searchResCmsb_cmd_val = self._cmd_group.get_repcap_cmd_value(searchResCmsb, repcap.SearchResCmsb) busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull) response = self._core.io.query_str(f'SEARch:RESult:CMSB{searchResCmsb_cmd_val}:FRAMe{busFrameNull_cmd_val}:STOP? {param}') return Conversions.str_to_float(response)