Source code for rsrtx.Implementations.Search.Result.Dphy.Frame.Data

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


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

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

[docs] def get(self, search: str, busFrameNull=repcap.BusFrameNull.Default) -> int: """ ``SEARch:RESult:DPHY:FRAMe<*>:DATA`` \n Snippet: ``value: int = driver.search.result.dphy.frame.data.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default)`` \n Returns the data or word count value for the selected frame within the search result. :param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame') :return: word_cnt_or_dat: 0 to 65.535E+3 """ param = Conversions.value_to_quoted_str(search) busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull) response = self._core.io.query_str(f'SEARch:RESult:DPHY:FRAMe{busFrameNull_cmd_val}:DATA? {param}') return Conversions.str_to_int(response)