from typing import List
from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SettingCls:
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("setting", core, parent)
[docs]
def get_catalog(self) -> List[str]:
"""
``[SOURce<HW>]:BB:ARBitrary:MCARrier:SETTing:CATalog`` \n
Snippet: ``value: List[str] = driver.source.bb.arbitrary.mcarrier.setting.get_catalog()`` \n
Queries the files with settings in the default directory. Listed are files with the file extension arb_multcarr.
:return: catalog: string
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:ARBitrary:MCARrier:SETTing:CATalog?')
return Conversions.str_to_str_list(response)
[docs]
def load(self, filename: str) -> None:
"""
``[SOURce<HW>]:BB:ARBitrary:MCARrier:SETTing:LOAD`` \n
Snippet: ``driver.source.bb.arbitrary.mcarrier.setting.load(filename = 'abc')`` \n
Loads the selected file from the default or the specified directory. Loaded are files with extension arb_multcarr. Refer
to 'Handling files in the default or in a specified directory' for general information on file handling in the default
and in a specific directory.
:param filename: 'filename' Filename or complete file path; file extension can be omitted.
"""
param = Conversions.value_to_quoted_str(filename)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:SETTing:LOAD {param}')
[docs]
def set_store(self, filename: str) -> None:
"""
``[SOURce<HW>]:BB:ARBitrary:MCARrier:SETTing:STORe`` \n
Snippet: ``driver.source.bb.arbitrary.mcarrier.setting.set_store(filename = 'abc')`` \n
Saves the current settings into the selected file; the file extension (arb_multcarr) is assigned automatically. Refer to
'Handling files in the default or in a specified directory' for general information on file handling in the default and
in a specific directory.
:param filename: string Filename or complete file path
"""
param = Conversions.value_to_quoted_str(filename)
self._core.io.write(f'SOURce<HwInstance>:BB:ARBitrary:MCARrier:SETTing:STORe {param}')