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 repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DmaxCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("dmax", core, parent)
[docs]
def set(self, search: str, data_max: int, busFrameNull=repcap.BusFrameNull.Default, busFieldNull=repcap.BusFieldNull.Default) -> None:
"""
``SEARch:TRIGger:USBPd:FRAMe<*>:FLD<*>:DMAX`` \n
Snippet: ``driver.search.trigger.usbPd.frame.fld.dmax.set(search = 'abc', data_max = 1, busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Sets the end value of a data pattern range if method ``RsRtx.search.trigger.usbPd.frame.fld.doperator.set()`` is set to
INRange or OORange.
:param search: String with the name of the search.
:param data_max: Specifies the name of the generic trigger setting frame, see method ``RsRtx.search.result.usbPd.frame.typePy.get()``.
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:param busFieldNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Fld')
"""
param = ArgSingleList().compose_cmd_string(ArgSingle('search', search, DataType.String), ArgSingle('data_max', data_max, DataType.Integer))
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
busFieldNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFieldNull, repcap.BusFieldNull)
self._core.io.write(f'SEARch:TRIGger:USBPd:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:DMAX {param}'.rstrip())
[docs]
def get(self, search: str, busFrameNull=repcap.BusFrameNull.Default, busFieldNull=repcap.BusFieldNull.Default) -> int:
"""
``SEARch:TRIGger:USBPd:FRAMe<*>:FLD<*>:DMAX`` \n
Snippet: ``value: int = driver.search.trigger.usbPd.frame.fld.dmax.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Sets the end value of a data pattern range if method ``RsRtx.search.trigger.usbPd.frame.fld.doperator.set()`` is set to
INRange or OORange.
:param search: String with the name of the search.
:param busFrameNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Frame')
:param busFieldNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Fld')
:return: data_max: Specifies the name of the generic trigger setting frame, see method ``RsRtx.search.result.usbPd.frame.typePy.get()``.
"""
param = Conversions.value_to_quoted_str(search)
busFrameNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFrameNull, repcap.BusFrameNull)
busFieldNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFieldNull, repcap.BusFieldNull)
response = self._core.io.query_str(f'SEARch:TRIGger:USBPd:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:DMAX? {param}')
return Conversions.str_to_int(response)