Source code for rsrtx.Implementations.Search.Trigger.FlxRay.Symbol

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from .....Internal.Types import DataType
from .....Internal.ArgSingleList import ArgSingleList
from .....Internal.ArgSingle import ArgSingle
from ..... import enums


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

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

[docs] def set(self, search: str, symbol: enums.BusFlxraySymbol) -> None: """ ``SEARch:TRIGger:FLXRay:SYMBol`` \n Snippet: ``driver.search.trigger.flxRay.symbol.set(search = 'abc', symbol = enums.BusFlxraySymbol.CASMts)`` \n Searches for a symbol or for a wakeup pattern. :param symbol: CASMts | WAKeup \n - CASMts: Collision Avoidance Symbol / Media access Test Symbol. These symbols are identical and can be sent in the optional symbol window at the end of a communication cycle. They are used to avoid collisions during the system start. - WAKeup: The wakeup pattern is sent to activate the nodes of the system. """ param = ArgSingleList().compose_cmd_string(ArgSingle('search', search, DataType.String), ArgSingle('symbol', symbol, DataType.Enum, enums.BusFlxraySymbol)) self._core.io.write(f'SEARch:TRIGger:FLXRay:SYMBol {param}'.rstrip())
# noinspection PyTypeChecker
[docs] def get(self, search: str) -> enums.BusFlxraySymbol: """ ``SEARch:TRIGger:FLXRay:SYMBol`` \n Snippet: ``value: enums.BusFlxraySymbol = driver.search.trigger.flxRay.symbol.get(search = 'abc')`` \n Searches for a symbol or for a wakeup pattern. :return: symbol: CASMts | WAKeup \n - CASMts: Collision Avoidance Symbol / Media access Test Symbol. These symbols are identical and can be sent in the optional symbol window at the end of a communication cycle. They are used to avoid collisions during the system start. - WAKeup: The wakeup pattern is sent to activate the nodes of the system. """ param = Conversions.value_to_quoted_str(search) response = self._core.io.query_str(f'SEARch:TRIGger:FLXRay:SYMBol? {param}') return Conversions.str_to_scalar_enum(response, enums.BusFlxraySymbol)