Source code for rsrtx.Implementations.Search.Result.Cmsb.Fcount

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


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

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

[docs] def get(self, search: str, searchResCmsb=repcap.SearchResCmsb.Default) -> int: """ ``SEARch:RESult:CMSB<*>:FCOunt`` \n Snippet: ``value: int = driver.search.result.cmsb.fcount.get(search = 'abc', searchResCmsb = repcap.SearchResCmsb.Default)`` \n Returns the count number of decoded result frames in a custom serial bus waveform. Basically, this is the maximum result index <n> when querying results by using SEARch:RESult:CMSB<m>:FRAMe<n>:XXX. :param searchResCmsb: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Cmsb') :return: frame_count: 0 to 100E+3 """ param = Conversions.value_to_quoted_str(search) searchResCmsb_cmd_val = self._cmd_group.get_repcap_cmd_value(searchResCmsb, repcap.SearchResCmsb) response = self._core.io.query_str(f'SEARch:RESult:CMSB{searchResCmsb_cmd_val}:FCOunt? {param}') return Conversions.str_to_int(response)