from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal.Utilities import trim_str_response
from ...... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ListPyCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("listPy", core, parent)
[docs]
def get(self, userNull=repcap.UserNull.Default) -> str:
"""
``[SOURce<HW>]:BB:OFDM:USER<CH0>:LIST`` \n
Snippet: ``value: str = driver.source.bb.ofdm.user.listPy.get(userNull = repcap.UserNull.Default)`` \n
Selects an existing data list file from the default directory or from the specific directory. Refer to 'Accessing Files
in the Default or Specified Directory' for general information on file handling in the default and in a specific
directory.
:param userNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'User')
:return: data_list: string file name incl. file extension or complete file path
"""
userNull_cmd_val = self._cmd_group.get_repcap_cmd_value(userNull, repcap.UserNull)
response = self._core.io.query_str(f'SOURce<HwInstance>:BB:OFDM:USER{userNull_cmd_val}:LIST?')
return trim_str_response(response)