from typing import List
from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.RepeatedCapability import RepeatedCapability
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class SpathCls:
"""Spath commands group definition. 3 total commands, 1 Subgroups, 1 group commands
Repeated Capability: Stream, default value after init: Stream.Nr1"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("spath", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_stream_get', 'repcap_stream_set', repcap.Stream.Nr1)
def repcap_stream_set(self, stream: repcap.Stream) -> None:
"""Repeated Capability default value numeric suffix.
This value is used, if you do not explicitely set it in the child set/get methods, or if you leave it to Stream.Default
Default value after init: Stream.Nr1"""
self._cmd_group.set_repcap_enum_value(stream)
def repcap_stream_get(self) -> repcap.Stream:
"""Returns the current default repeated capability for the child set/get methods"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def group(self):
"""group commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_group'):
from .Group import GroupCls
self._group = GroupCls(self._core, self._cmd_group)
return self._group
[docs]
def get(self, stream=repcap.Stream.Default) -> List[str]:
"""SCPI: CATalog:GPRF:GENerator<Instance>:SPATh<StreamNumber> \n
Snippet: value: List[str] = driver.catalog.gprf.generator.spath.get(stream = repcap.Stream.Default) \n
Returns the names of the available RF connections (broadcast off) or connector groups (broadcast on) . \n
:param stream: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Spath')
:return: name_signal_path: Comma-separated list of strings, one string per name."""
stream_cmd_val = self._cmd_group.get_repcap_cmd_value(stream, repcap.Stream)
response = self._core.io.query_str(f'CATalog:GPRF:GENerator<Instance>:SPATh{stream_cmd_val}?')
return Conversions.str_to_str_list(response)
def clone(self) -> 'SpathCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = SpathCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group