from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class TrainCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("train", core, parent)
[docs]
def set(self) -> None:
"""
``CONFigure:EQUalizer:TRAin`` \n
Snippet: ``driver.applications.k18AmplifierEt.configure.equalizer.train.set()`` \n
This command initiates a training sequence for the equalizer filter. Note that you have to synchronize the measurement
before you can initiate a training sequence.
Prerequisites for this command \n
- Define a filter length (method ``RsFsw.applications.k18AmplifierEt.configure.equalizer.filterPy.length.set()`` ) .
"""
self._core.io.write(f'CONFigure:EQUalizer:TRAin')
[docs]
def set_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``CONFigure:EQUalizer:TRAin`` \n
Snippet: ``driver.applications.k18AmplifierEt.configure.equalizer.train.set_with_opc()`` \n
This command initiates a training sequence for the equalizer filter. Note that you have to synchronize the measurement
before you can initiate a training sequence.
Prerequisites for this command \n
- Define a filter length (method ``RsFsw.applications.k18AmplifierEt.configure.equalizer.filterPy.length.set()`` ) .
Same as set, but waits for the operation to complete before continuing further. Use the RsFsw.utilities.opc_timeout_set() to set the timeout value.
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'CONFigure:EQUalizer:TRAin', opc_timeout_ms)