from typing import List
from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class RefSignalCls:
"""
| Commands in total: 4
| Subgroups: 1
| Direct child commands: 2
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("refSignal", core, parent)
@property
def filterPy(self):
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
if not hasattr(self, '_filterPy'):
from .FilterPy import FilterPyCls
self._filterPy = FilterPyCls(self._core, self._cmd_group)
return self._filterPy
[docs]
def get_catalog(self) -> List[str]:
"""
``[SOURce<HW>]:BB:KUIPer:REFSignal:CATalog`` \n
Snippet: ``value: List[str] = driver.source.bb.kuiper.refSignal.get_catalog()`` \n
Queries the available reference signal files. Listed are predefined files.
:return: ref_sig_cata_log: string Returns a string of filenames separated by commas.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:KUIPer:REFSignal:CATalog?')
return Conversions.str_to_str_list(response)
[docs]
def get_value(self) -> str:
"""
``[SOURce<HW>]:BB:KUIPer:REFSignal`` \n
Snippet: ``value: str = driver.source.bb.kuiper.refSignal.get_value()`` \n
Selects and loads a predefined reference signal.
:return: ref_signal: string Filename; you can omit the file extension.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:KUIPer:REFSignal?')
return trim_str_response(response)
def clone(self) -> 'RefSignalCls':
"""
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 = RefSignalCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group