from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class BoffsetCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("boffset", core, parent)
[docs]
def set(self, bit_offset: int, trigger=repcap.Trigger.Default, triggerPattern=repcap.TriggerPattern.Default) -> None:
"""
``TRIGger<*>:SERPattern:COMPlex:PATTern<*>:BOFFset`` \n
Snippet: ``driver.trigger.serPattern.complex.pattern.boffset.set(bit_offset = 1, trigger = repcap.Trigger.Default, triggerPattern = repcap.TriggerPattern.Default)`` \n
Sets the number of arbitrary bits between the first bit after the frame id and the first bit of the word pattern.
:param bit_offset: 0 to 255
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
:param triggerPattern: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Pattern')
"""
param = Conversions.decimal_value_to_str(bit_offset)
trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
triggerPattern_cmd_val = self._cmd_group.get_repcap_cmd_value(triggerPattern, repcap.TriggerPattern)
self._core.io.write(f'TRIGger{trigger_cmd_val}:SERPattern:COMPlex:PATTern{triggerPattern_cmd_val}:BOFFset {param}')
[docs]
def get(self, trigger=repcap.Trigger.Default, triggerPattern=repcap.TriggerPattern.Default) -> int:
"""
``TRIGger<*>:SERPattern:COMPlex:PATTern<*>:BOFFset`` \n
Snippet: ``value: int = driver.trigger.serPattern.complex.pattern.boffset.get(trigger = repcap.Trigger.Default, triggerPattern = repcap.TriggerPattern.Default)`` \n
Sets the number of arbitrary bits between the first bit after the frame id and the first bit of the word pattern.
:param trigger: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Trigger')
:param triggerPattern: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Pattern')
:return: bit_offset: 0 to 255
"""
trigger_cmd_val = self._cmd_group.get_repcap_cmd_value(trigger, repcap.Trigger)
triggerPattern_cmd_val = self._cmd_group.get_repcap_cmd_value(triggerPattern, repcap.TriggerPattern)
response = self._core.io.query_str(f'TRIGger{trigger_cmd_val}:SERPattern:COMPlex:PATTern{triggerPattern_cmd_val}:BOFFset?')
return Conversions.str_to_int(response)