from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
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 MsgValueCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("msgValue", core, parent)
[docs]
def set(self, search_name: str, message_name: str) -> None:
"""
``SEARch:TRIGger:CAN:SYMBolic:MSGValue`` \n
Snippet: ``driver.search.trigger.can.symbolic.msgValue.set(search_name = 'abc', message_name = 'abc')`` \n
Sets the message to be triggered or searched for. The setting is used by symbolic trigger and symbolic search. Thus, you
always trigger on and search for the same message if symbolic trigger and symbolic search is used at the same time. See
also: method ``RsRtx.trigger.can.symbolic.msgValue.set()``
:param search_name: String that contains the search definition name
:param message_name: String that contains the symbolic message name
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('search_name', search_name, DataType.String), ArgSingle('message_name', message_name, DataType.String))
self._core.io.write(f'SEARch:TRIGger:CAN:SYMBolic:MSGValue {param}'.rstrip())
[docs]
def get(self, search_name: str) -> str:
"""
``SEARch:TRIGger:CAN:SYMBolic:MSGValue`` \n
Snippet: ``value: str = driver.search.trigger.can.symbolic.msgValue.get(search_name = 'abc')`` \n
Sets the message to be triggered or searched for. The setting is used by symbolic trigger and symbolic search. Thus, you
always trigger on and search for the same message if symbolic trigger and symbolic search is used at the same time. See
also: method ``RsRtx.trigger.can.symbolic.msgValue.set()``
:param search_name: String that contains the search definition name
:return: message_name: String that contains the symbolic message name
"""
param = Conversions.value_to_quoted_str(search_name)
response = self._core.io.query_str(f'SEARch:TRIGger:CAN:SYMBolic:MSGValue? {param}')
return trim_str_response(response)