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
[docs]class SettingCls:
"""Setting commands group definition. 4 total commands, 0 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("setting", core, parent)
[docs] def get_catalog(self) -> List[str]:
"""SCPI: [SOURce<HW>]:BB:OFDM:SETTing:CATalog \n
Snippet: value: List[str] = driver.source.bb.ofdm.setting.get_catalog() \n
Queries the files with settings in the default directory. Listed are files with the file extension *.c5g.
Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default
and in a specific directory. \n
:return: c_5_gcat_name: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:SETTing:CATalog?')
return Conversions.str_to_str_list(response)
[docs] def get_del_py(self) -> str:
"""SCPI: [SOURce<HW>]:BB:OFDM:SETTing:DEL \n
Snippet: value: str = driver.source.bb.ofdm.setting.get_del_py() \n
Deletes the selected file from the default or specified directory. Deleted are files with the file extension *.c5g. Refer
to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default and in
a specific directory. \n
:return: filename: string file name or complete file path; file extension can be omitted
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:SETTing:DEL?')
return trim_str_response(response)
[docs] def set_del_py(self, filename: str) -> None:
"""SCPI: [SOURce<HW>]:BB:OFDM:SETTing:DEL \n
Snippet: driver.source.bb.ofdm.setting.set_del_py(filename = 'abc') \n
Deletes the selected file from the default or specified directory. Deleted are files with the file extension *.c5g. Refer
to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default and in
a specific directory. \n
:param filename: string file name or complete file path; file extension can be omitted
"""
param = Conversions.value_to_quoted_str(filename)
self._core.io.write(f'SOURce<HwInstance>:BB:OFDM:SETTing:DEL {param}')
[docs] def get_load(self) -> str:
"""SCPI: [SOURce<HW>]:BB:OFDM:SETTing:LOAD \n
Snippet: value: str = driver.source.bb.ofdm.setting.get_load() \n
Loads the selected file from the default or the specified directory. Loaded are files with extension *.c5g.
Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default
and in a specific directory. \n
:return: filename: string file name or complete file path; file extension can be omitted
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:SETTing:LOAD?')
return trim_str_response(response)
[docs] def set_load(self, filename: str) -> None:
"""SCPI: [SOURce<HW>]:BB:OFDM:SETTing:LOAD \n
Snippet: driver.source.bb.ofdm.setting.set_load(filename = 'abc') \n
Loads the selected file from the default or the specified directory. Loaded are files with extension *.c5g.
Refer to 'Accessing Files in the Default or Specified Directory' for general information on file handling in the default
and in a specific directory. \n
:param filename: string file name or complete file path; file extension can be omitted
"""
param = Conversions.value_to_quoted_str(filename)
self._core.io.write(f'SOURce<HwInstance>:BB:OFDM:SETTing:LOAD {param}')
[docs] def get_store(self) -> str:
"""SCPI: [SOURce<HW>]:BB:OFDM:SETTing:STORe \n
Snippet: value: str = driver.source.bb.ofdm.setting.get_store() \n
Stores the current settings into the selected file; the file extension (*.c5g) 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. \n
:return: filename: string file name or complete file path
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:OFDM:SETTing:STORe?')
return trim_str_response(response)
[docs] def set_store(self, filename: str) -> None:
"""SCPI: [SOURce<HW>]:BB:OFDM:SETTing:STORe \n
Snippet: driver.source.bb.ofdm.setting.set_store(filename = 'abc') \n
Stores the current settings into the selected file; the file extension (*.c5g) 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. \n
:param filename: string file name or complete file path
"""
param = Conversions.value_to_quoted_str(filename)
self._core.io.write(f'SOURce<HwInstance>:BB:OFDM:SETTing:STORe {param}')