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 SettingCls:
"""
| Commands in total: 20
| Subgroups: 2
| Direct child commands: 4
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("setting", core, parent)
@property
def exchange(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_exchange'):
from .Exchange import ExchangeCls
self._exchange = ExchangeCls(self._core, self._cmd_group)
return self._exchange
@property
def tmodel(self):
"""
| Commands in total: 15
| Subgroups: 4
| Direct child commands: 2
"""
if not hasattr(self, '_tmodel'):
from .Tmodel import TmodelCls
self._tmodel = TmodelCls(self._core, self._cmd_group)
return self._tmodel
[docs]
def get_catalog(self) -> List[str]:
"""
``[SOURce<HW>]:BB:NR5G:SETTing:CATalog`` \n
Snippet: ``value: List[str] = driver.source.bb.nr5G.setting.get_catalog()`` \n
Queries the files with settings in the default directory. Listed are files with the file extension nr5g.
Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default
and in a specific directory.
:return: nr_5_gcat_name: filename1,filename2,... Returns a string of filenames separated by commas.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:SETTing:CATalog?')
return Conversions.str_to_str_list(response)
[docs]
def get_del_py(self) -> str:
"""
``[SOURce<HW>]:BB:NR5G:SETTing:DEL`` \n
Snippet: ``value: str = driver.source.bb.nr5G.setting.get_del_py()`` \n
Deletes the selected file from the default or the specified directory. Deleted are files with extension nr5g. Refer to
'Accessing Files in the Default or Specified Directory' for general information on file handling in the default and in a
specific directory.
:return: filename: 'filename' Filename or complete file path; file extension can be omitted
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:SETTing:DEL?')
return trim_str_response(response)
[docs]
def get_load(self) -> str:
"""
``[SOURce<HW>]:BB:NR5G:SETTing:LOAD`` \n
Snippet: ``value: str = driver.source.bb.nr5G.setting.get_load()`` \n
Loads the selected file from the default or the specified directory. Loaded are files with extension nr5g.
Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default
and in a specific directory.
:return: filename: 'filename' Filename or complete file path; file extension can be omitted
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:SETTing:LOAD?')
return trim_str_response(response)
[docs]
def get_store(self) -> str:
"""
``[SOURce<HW>]:BB:NR5G:SETTing:STORe`` \n
Snippet: ``value: str = driver.source.bb.nr5G.setting.get_store()`` \n
Saves the current settings into the selected file; the file extension (nr5g) is assigned automatically.
Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default
and in a specific directory.
:return: filename: 'filename' Filename or complete file path
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:NR5G:SETTing:STORe?')
return trim_str_response(response)
def clone(self) -> 'SettingCls':
"""
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 = SettingCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group