from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class NumWordsCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("numWords", core, parent)
[docs]
def get(self, bus=repcap.Bus.Default, word=repcap.Word.Default) -> int:
"""
``BUS<*>:ETHernet:WORD<*>:NUMWords`` \n
Snippet: ``value: int = driver.bus.ethernet.word.numWords.get(bus = repcap.Bus.Default, word = repcap.Word.Default)`` \n
Returns the number of words in the selected frame. The result corresponds to the Number of Words column in the results
table.
:param bus: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Bus')
:param word: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Word')
:return: num_words: 0 to 4.29497E+9
"""
bus_cmd_val = self._cmd_group.get_repcap_cmd_value(bus, repcap.Bus)
word_cmd_val = self._cmd_group.get_repcap_cmd_value(word, repcap.Word)
response = self._core.io.query_str(f'BUS{bus_cmd_val}:ETHernet:WORD{word_cmd_val}:NUMWords?')
return Conversions.str_to_int(response)