from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class PrampCls:
"""
| Commands in total: 48
| Subgroups: 5
| Direct child commands: 2
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("pramp", core, parent)
@property
def clock(self):
"""
| Commands in total: 3
| Subgroups: 0
| Direct child commands: 3
"""
if not hasattr(self, '_clock'):
from .Clock import ClockCls
self._clock = ClockCls(self._core, self._cmd_group)
return self._clock
@property
def ramp(self):
"""
| Commands in total: 21
| Subgroups: 5
| Direct child commands: 10
"""
if not hasattr(self, '_ramp'):
from .Ramp import RampCls
self._ramp = RampCls(self._core, self._cmd_group)
return self._ramp
@property
def setting(self):
"""
| Commands in total: 4
| Subgroups: 0
| Direct child commands: 4
"""
if not hasattr(self, '_setting'):
from .Setting import SettingCls
self._setting = SettingCls(self._core, self._cmd_group)
return self._setting
@property
def trigger(self):
"""
| Commands in total: 17
| Subgroups: 6
| Direct child commands: 5
"""
if not hasattr(self, '_trigger'):
from .Trigger import TriggerCls
self._trigger = TriggerCls(self._core, self._cmd_group)
return self._trigger
@property
def waveform(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_waveform'):
from .Waveform import WaveformCls
self._waveform = WaveformCls(self._core, self._cmd_group)
return self._waveform
[docs]
def preset(self) -> None:
"""
``[SOURce<HW>]:BB:PRAMp:PRESet`` \n
Snippet: ``driver.source.bb.pramp.preset()`` \n
Sets the parameters of the power sweep to their default values (``*RST`` values specified for the commands) .
Not affected is the state set with the method ``RsSmw.source.bb.pramp.state()`` .
"""
self._core.io.write(f'SOURce<HwInstance>:BB:PRAMp:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""
``[SOURce<HW>]:BB:PRAMp:PRESet`` \n
Snippet: ``driver.source.bb.pramp.preset_with_opc()`` \n
Sets the parameters of the power sweep to their default values (``*RST`` values specified for the commands) .
Not affected is the state set with the method ``RsSmw.source.bb.pramp.state()`` .
Same as preset, but waits for the operation to complete before continuing further. Use the RsSmw.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'SOURce<HwInstance>:BB:PRAMp:PRESet', opc_timeout_ms)
[docs]
def get_state(self) -> bool:
"""
``[SOURce<HW>]:BB:PRAMp:STATe`` \n
Snippet: ``value: bool = driver.source.bb.pramp.get_state()`` \n
Activates power sweep signal generation, and deactivates all digital standards, digital modulation modes and other sweeps
in the corresponding path.
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:PRAMp:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""
``[SOURce<HW>]:BB:PRAMp:STATe`` \n
Snippet: ``driver.source.bb.pramp.set_state(state = False)`` \n
Activates power sweep signal generation, and deactivates all digital standards, digital modulation modes and other sweeps
in the corresponding path.
:param state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:PRAMp:STATe {param}')
def clone(self) -> 'PrampCls':
"""
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 = PrampCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group