from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal.RepeatedCapability import RepeatedCapability
from ....... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SfConfigCls:
"""
| Commands in total: 48
| Subgroups: 3
| Direct child commands: 2
Repeated Capability Setting:
.. code-block:: python
# Range: Nr0 .. Nr31 \n
driver.source.bb.dvb.dvbr.sfConfig.repcap_sfCfgIxNull_set(repcap.SfCfgIxNull.Nr0)
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("sfConfig", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_sfCfgIxNull_get', 'repcap_sfCfgIxNull_set', repcap.SfCfgIxNull.Nr0)
def repcap_sfCfgIxNull_set(self, sfCfgIxNull: repcap.SfCfgIxNull) -> None:
"""
Repeated Capability default value numeric suffix.
This value is used, if you do not explicitely set it in the child set/get methods, or if you leave it to SfCfgIxNull.Default.
Default value after init: SfCfgIxNull.Nr0
"""
self._cmd_group.set_repcap_enum_value(sfCfgIxNull)
def repcap_sfCfgIxNull_get(self) -> repcap.SfCfgIxNull:
"""
Returns the current default repeated capability for the child set/get methods.
"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def append(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_append'):
from .Append import AppendCls
self._append = AppendCls(self._core, self._cmd_group)
return self._append
@property
def frames(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_frames'):
from .Frames import FramesCls
self._frames = FramesCls(self._core, self._cmd_group)
return self._frames
@property
def frConfig(self):
"""
| Commands in total: 44
| Subgroups: 12
| Direct child commands: 0
"""
if not hasattr(self, '_frConfig'):
from .FrConfig import FrConfigCls
self._frConfig = FrConfigCls(self._core, self._cmd_group)
return self._frConfig
[docs]
def delete(self, sfCfgIxNull=repcap.SfCfgIxNull.Default) -> None:
"""
``[SOURce<HW>]:BB:DVB:DVBR:SFConfig<CH0>:DELete`` \n
Snippet: ``driver.source.bb.dvb.dvbr.sfConfig.delete(sfCfgIxNull = repcap.SfCfgIxNull.Default)`` \n
Standard function to append or remove a frame from the table.
:param sfCfgIxNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'SfConfig')
"""
sfCfgIxNull_cmd_val = self._cmd_group.get_repcap_cmd_value(sfCfgIxNull, repcap.SfCfgIxNull)
self._core.io.write(f'SOURce<HwInstance>:BB:DVB:DVBR:SFConfig{sfCfgIxNull_cmd_val}:DELete')
[docs]
def delete_with_opc(self, sfCfgIxNull=repcap.SfCfgIxNull.Default, opc_timeout_ms: int = -1) -> None:
sfCfgIxNull_cmd_val = self._cmd_group.get_repcap_cmd_value(sfCfgIxNull, repcap.SfCfgIxNull)
"""
``[SOURce<HW>]:BB:DVB:DVBR:SFConfig<CH0>:DELete`` \n
Snippet: ``driver.source.bb.dvb.dvbr.sfConfig.delete_with_opc(sfCfgIxNull = repcap.SfCfgIxNull.Default)`` \n
Standard function to append or remove a frame from the table.
Same as delete, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.
:param sfCfgIxNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'SfConfig')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'SOURce<HwInstance>:BB:DVB:DVBR:SFConfig{sfCfgIxNull_cmd_val}:DELete', opc_timeout_ms)
[docs]
def reset(self, sfCfgIxNull=repcap.SfCfgIxNull.Default) -> None:
"""
``[SOURce<HW>]:BB:DVB:DVBR:SFConfig<CH0>:RESet`` \n
Snippet: ``driver.source.bb.dvb.dvbr.sfConfig.reset(sfCfgIxNull = repcap.SfCfgIxNull.Default)`` \n
Resets the frame table, that is, removes all frames but the first one and presets the frame central frequency offset and
frame bandwidth to the default values.
:param sfCfgIxNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'SfConfig')
"""
sfCfgIxNull_cmd_val = self._cmd_group.get_repcap_cmd_value(sfCfgIxNull, repcap.SfCfgIxNull)
self._core.io.write(f'SOURce<HwInstance>:BB:DVB:DVBR:SFConfig{sfCfgIxNull_cmd_val}:RESet')
[docs]
def reset_with_opc(self, sfCfgIxNull=repcap.SfCfgIxNull.Default, opc_timeout_ms: int = -1) -> None:
sfCfgIxNull_cmd_val = self._cmd_group.get_repcap_cmd_value(sfCfgIxNull, repcap.SfCfgIxNull)
"""
``[SOURce<HW>]:BB:DVB:DVBR:SFConfig<CH0>:RESet`` \n
Snippet: ``driver.source.bb.dvb.dvbr.sfConfig.reset_with_opc(sfCfgIxNull = repcap.SfCfgIxNull.Default)`` \n
Resets the frame table, that is, removes all frames but the first one and presets the frame central frequency offset and
frame bandwidth to the default values.
Same as reset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value.
:param sfCfgIxNull: optional repeated capability selector. Default value: Nr0 (settable in the interface 'SfConfig')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'SOURce<HwInstance>:BB:DVB:DVBR:SFConfig{sfCfgIxNull_cmd_val}:RESet', opc_timeout_ms)
def clone(self) -> 'SfConfigCls':
"""
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 = SfConfigCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group