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 LogGenCls:
"""LogGen commands group definition. 25 total commands, 2 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("logGen", core, parent)
@property
def downlink(self):
"""downlink commands group. 3 Sub-classes, 6 commands."""
if not hasattr(self, '_downlink'):
from .Downlink import DownlinkCls
self._downlink = DownlinkCls(self._core, self._cmd_group)
return self._downlink
@property
def uplink(self):
"""uplink commands group. 3 Sub-classes, 9 commands."""
if not hasattr(self, '_uplink'):
from .Uplink import UplinkCls
self._uplink = UplinkCls(self._core, self._cmd_group)
return self._uplink
[docs]
def get_gs_log_file(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:GSLogfile \n
Snippet: value: bool = driver.source.bb.eutra.logGen.get_gs_log_file() \n
Enables the generation of a summary logfile. \n
:return: gen_sum_log: 1| ON| 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:LOGGen:GSLogfile?')
return Conversions.str_to_bool(response)
[docs]
def set_gs_log_file(self, gen_sum_log: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:GSLogfile \n
Snippet: driver.source.bb.eutra.logGen.set_gs_log_file(gen_sum_log = False) \n
Enables the generation of a summary logfile. \n
:param gen_sum_log: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(gen_sum_log)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:LOGGen:GSLogfile {param}')
[docs]
def get_lfp(self) -> str:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:LFP \n
Snippet: value: str = driver.source.bb.eutra.logGen.get_lfp() \n
Sets the preamble added to the file name. See 'Filenames' for a description of the file naming conventions. \n
:return: preamble: string
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:LOGGen:LFP?')
return trim_str_response(response)
[docs]
def set_lfp(self, preamble: str) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:LFP \n
Snippet: driver.source.bb.eutra.logGen.set_lfp(preamble = 'abc') \n
Sets the preamble added to the file name. See 'Filenames' for a description of the file naming conventions. \n
:param preamble: string
"""
param = Conversions.value_to_quoted_str(preamble)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:LOGGen:LFP {param}')
[docs]
def get_output(self) -> str:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:OUTPut \n
Snippet: value: str = driver.source.bb.eutra.logGen.get_output() \n
Selects the network directory the logged files are stored in. \n
:return: output_path: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:LOGGen:OUTPut?')
return trim_str_response(response)
[docs]
def set_output(self, output_path: str) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:OUTPut \n
Snippet: driver.source.bb.eutra.logGen.set_output(output_path = 'abc') \n
Selects the network directory the logged files are stored in. \n
:param output_path: No help available
"""
param = Conversions.value_to_quoted_str(output_path)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:LOGGen:OUTPut {param}')
[docs]
def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:STATe \n
Snippet: value: bool = driver.source.bb.eutra.logGen.get_state() \n
Enables/disables logfile generation. \n
:return: logging_state: 1| ON| 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:EUTRa:LOGGen:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, logging_state: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:EUTRa:LOGGen:STATe \n
Snippet: driver.source.bb.eutra.logGen.set_state(logging_state = False) \n
Enables/disables logfile generation. \n
:param logging_state: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(logging_state)
self._core.io.write(f'SOURce<HwInstance>:BB:EUTRa:LOGGen:STATe {param}')
def clone(self) -> 'LogGenCls':
"""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 = LogGenCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group