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 ImaxCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("imax", core, parent)
[docs]
def set(self, search: str, index_max: int, busFrameNull=repcap.BusFrameNull.Default, busFieldNull=repcap.BusFieldNull.Default) -> None:
"""
``SEARch:TRIGger:MPHY:SSIC:FRAMe<*>:FLD<*>:IMAX`` \n
Snippet: ``driver.search.trigger.mphy.ssic.frame.fld.imax.set(search = 'abc', index_max = 1, busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Sets the end value of an index range if method ``RsRtx.search.trigger.mphy.ssic.frame.fld.ioperator.set()`` is set to
INRange or RANGe.
:param index_max: Specifies the end value for the index range within the field. The index range, increment and ``*RST`` values depend on the field type.
: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('index_max', index_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:MPHY:SSIC:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:IMAX {param}'.rstrip())
[docs]
def get(self, search: str, busFrameNull=repcap.BusFrameNull.Default, busFieldNull=repcap.BusFieldNull.Default) -> int:
"""
``SEARch:TRIGger:MPHY:SSIC:FRAMe<*>:FLD<*>:IMAX`` \n
Snippet: ``value: int = driver.search.trigger.mphy.ssic.frame.fld.imax.get(search = 'abc', busFrameNull = repcap.BusFrameNull.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Sets the end value of an index range if method ``RsRtx.search.trigger.mphy.ssic.frame.fld.ioperator.set()`` is set to
INRange or RANGe.
: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: index_max: Specifies the end value for the index range within the field. The index range, increment and ``*RST`` values depend on the field type.
"""
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:MPHY:SSIC:FRAMe{busFrameNull_cmd_val}:FLD{busFieldNull_cmd_val}:IMAX? {param}')
return Conversions.str_to_int(response)