Source code for rsrtx.Implementations.Search.Result.All

from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal.Types import DataType
from ....Internal.Utilities import trim_str_response
from ....Internal.ArgSingleList import ArgSingleList
from ....Internal.ArgSingle import ArgSingle


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

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

[docs] def get(self, search: str, data: str) -> str: """ ``SEARch:RESult[:ALL]`` \n Snippet: ``value: str = driver.search.result.all.get(search = 'abc', data = 'abc')`` \n Returns all search results. :param search: Search definition :param data: List of search results, separated by commas. For each result, six values are returned: 1. Acquisition index, currently always 0. 2. X-position of the search result 3. Y-position of the search result, currently not relevant 4. Type of the search result (Edge, Glitch, ...) 5. Slope or polarity of the search result 6. For runt, glitch, width, and window searches, the value contains the width. For timeout and interval searches, it contains the timeout. For transition searches, it contains the slew rate. For all other searches, the value is not relevant. :return: data: List of search results, separated by commas. For each result, six values are returned: 1. Acquisition index, currently always 0. 2. X-position of the search result 3. Y-position of the search result, currently not relevant 4. Type of the search result (Edge, Glitch, ...) 5. Slope or polarity of the search result 6. For runt, glitch, width, and window searches, the value contains the width. For timeout and interval searches, it contains the timeout. For transition searches, it contains the slew rate. For all other searches, the value is not relevant. """ param = ArgSingleList().compose_cmd_string(ArgSingle('search', search, DataType.String), ArgSingle('data', data, DataType.String)) response = self._core.io.query_str_with_opc(f'SEARch:RESult:ALL? {param}'.rstrip()) return trim_str_response(response)