from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal.Utilities import trim_str_response
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class FvalCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("fval", core, parent)
[docs]
def get(self, bus=repcap.Bus.Default, busUsbPacket=repcap.BusUsbPacket.Default, busFieldNull=repcap.BusFieldNull.Default) -> str:
"""
``BUS<*>:PCIE:RESult:PACKet<*>:FLD<*>:FVAL`` \n
Snippet: ``value: str = driver.bus.pcie.result.packet.fld.fval.get(bus = repcap.Bus.Default, busUsbPacket = repcap.BusUsbPacket.Default, busFieldNull = repcap.BusFieldNull.Default)`` \n
Returns the formatted value of the field with the selected field number within the frame with the selected packet number
(for the selected serial bus) .
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param busUsbPacket: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Packet')
:param busFieldNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'Fld')
:return: value_formatted: String parameter
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
busUsbPacket_cmd_val = self._cmd_group.get_repcap_cmd_value(busUsbPacket, repcap.BusUsbPacket)
busFieldNull_cmd_val = self._cmd_group.get_repcap_cmd_value(busFieldNull, repcap.BusFieldNull)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:PCIE:RESult:PACKet{busUsbPacket_cmd_val}:FLD{busFieldNull_cmd_val}:FVAL?')
return trim_str_response(response)