from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StateCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
# noinspection PyTypeChecker
[docs]
def get(self, probe=repcap.Probe.Default) -> enums.Result:
"""
``PROBe<*>:SETup:ALIGnment:STATe`` \n
Snippet: ``value: enums.Result = driver.probe.setup.alignment.state.get(probe = repcap.Probe.Default)`` \n
Returns the result of the probe alignment.
:param probe: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Probe')
:return: alignment_state: PASS | FAIL
"""
probe_cmd_val = self._cmd_group.get_repcap_cmd_value(probe, repcap.Probe)
response = self._core.io.query_str_with_opc(f'PROBe{probe_cmd_val}:SETup:ALIGnment:STATe?')
return Conversions.str_to_scalar_enum(response, enums.Result)