Source code for rsrtx.Implementations.Search.Result.Spi.Frame.Count

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


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

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

[docs] def get(self, busFrameNull=repcap.BusFrameNull.Default) -> int: """ ``SEARch:RESult:SPI:FRAMe<*>:COUNt`` \n Snippet: ``value: int = driver.search.result.spi.frame.count.get(busFrameNull = repcap.BusFrameNull.Default)`` \n Returns the number of frames that have matched the search criteria. In the search result table on the display, the number of rows is the number of frames that match the search criteria. :param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame') """ busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull) response = self._core.io.query_str(f'SEARch:RESult:SPI:FRAMe{busFrameNull_cmd_val}:COUNt?') return Conversions.str_to_int(response)