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
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class AfileCls:
"""Afile commands group definition. 5 total commands, 1 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("afile", core, parent)
@property
def separator(self):
"""separator commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_separator'):
from .Separator import SeparatorCls
self._separator = SeparatorCls(self._core, self._cmd_group)
return self._separator
[docs] def get_catalog(self) -> List[str]:
"""SCPI: [SOURce<HW>]:CORRection:DEXChange:AFILe:CATalog \n
Snippet: value: List[str] = driver.source.correction.dexchange.afile.get_catalog() \n
Queries the available ASCII files for export or import of user correction data in the current or specified directory. \n
:return: catalog: string List of ASCII files *.txt or *.csv, separated by commas.
"""
response = self._core.io.query_str('SOURce<HwInstance>:CORRection:DEXChange:AFILe:CATalog?')
return Conversions.str_to_str_list(response)
# noinspection PyTypeChecker
[docs] def get_extension(self) -> enums.DexchExtension:
"""SCPI: [SOURce<HW>]:CORRection:DEXChange:AFILe:EXTension \n
Snippet: value: enums.DexchExtension = driver.source.correction.dexchange.afile.get_extension() \n
Determines the extension of the ASCII files for file import or export, or to query existing files. \n
:return: extension: TXT| CSV
"""
response = self._core.io.query_str('SOURce<HwInstance>:CORRection:DEXChange:AFILe:EXTension?')
return Conversions.str_to_scalar_enum(response, enums.DexchExtension)
[docs] def set_extension(self, extension: enums.DexchExtension) -> None:
"""SCPI: [SOURce<HW>]:CORRection:DEXChange:AFILe:EXTension \n
Snippet: driver.source.correction.dexchange.afile.set_extension(extension = enums.DexchExtension.CSV) \n
Determines the extension of the ASCII files for file import or export, or to query existing files. \n
:param extension: TXT| CSV
"""
param = Conversions.enum_scalar_to_str(extension, enums.DexchExtension)
self._core.io.write(f'SOURce<HwInstance>:CORRection:DEXChange:AFILe:EXTension {param}')
[docs] def get_select(self) -> str:
"""SCPI: [SOURce<HW>]:CORRection:DEXChange:AFILe:SELect \n
Snippet: value: str = driver.source.correction.dexchange.afile.get_select() \n
Selects the ASCII file to be imported or exported. \n
:return: filename: string Filename or complete file path; file extension can be omitted.
"""
response = self._core.io.query_str('SOURce<HwInstance>:CORRection:DEXChange:AFILe:SELect?')
return trim_str_response(response)
[docs] def set_select(self, filename: str) -> None:
"""SCPI: [SOURce<HW>]:CORRection:DEXChange:AFILe:SELect \n
Snippet: driver.source.correction.dexchange.afile.set_select(filename = 'abc') \n
Selects the ASCII file to be imported or exported. \n
:param filename: string Filename or complete file path; file extension can be omitted.
"""
param = Conversions.value_to_quoted_str(filename)
self._core.io.write(f'SOURce<HwInstance>:CORRection:DEXChange:AFILe:SELect {param}')
def clone(self) -> 'AfileCls':
"""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 = AfileCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group