from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from .... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class StepCls:
"""
| Commands in total: 2
| Subgroups: 0
| Direct child commands: 2
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("step", core, parent)
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.FreqStepMode:
"""
``[SOURce<HW>]:FREQuency:STEP:MODE`` \n
Snippet: ``value: enums.FreqStepMode = driver.source.frequency.step.get_mode()`` \n
Defines the type of step size to vary the RF frequency at discrete steps with the commands FREQ UP or FREQ DOWN.
:return: mode: DECimal | USER DECimal Increases or decreases the level in steps of ten. USER Increases or decreases the level in increments, set with the command FREQ:STEP[:INCR].
"""
response = self._core.io.query_str('SOURce<HwInstance>:FREQuency:STEP:MODE?')
return Conversions.str_to_scalar_enum(response, enums.FreqStepMode)
[docs]
def set_mode(self, mode: enums.FreqStepMode) -> None:
"""
``[SOURce<HW>]:FREQuency:STEP:MODE`` \n
Snippet: ``driver.source.frequency.step.set_mode(mode = enums.FreqStepMode.DECimal)`` \n
Defines the type of step size to vary the RF frequency at discrete steps with the commands FREQ UP or FREQ DOWN.
:param mode: DECimal | USER DECimal Increases or decreases the level in steps of ten. USER Increases or decreases the level in increments, set with the command FREQ:STEP[:INCR].
"""
param = Conversions.enum_scalar_to_str(mode, enums.FreqStepMode)
self._core.io.write(f'SOURce<HwInstance>:FREQuency:STEP:MODE {param}')
[docs]
def get_increment(self) -> float:
"""
``[SOURce<HW>]:FREQuency:STEP:[INCRement]`` \n
Snippet: ``value: float = driver.source.frequency.step.get_increment()`` \n
Sets the step width. You can use this value to vary the RF frequency with command FREQ UP or FREQ DOWN, if you have
activated FREQ:STEP:MODE USER. Note: This value also applies to the step width of the rotary knob on the instrument and,
in user-defined step mode, increases or decreases the frequency.
:return: increment: float Range: 0 Hz to RFmax - 100 kHz
"""
response = self._core.io.query_str('SOURce<HwInstance>:FREQuency:STEP:INCRement?')
return Conversions.str_to_float(response)
[docs]
def set_increment(self, increment: float) -> None:
"""
``[SOURce<HW>]:FREQuency:STEP:[INCRement]`` \n
Snippet: ``driver.source.frequency.step.set_increment(increment = 1.0)`` \n
Sets the step width. You can use this value to vary the RF frequency with command FREQ UP or FREQ DOWN, if you have
activated FREQ:STEP:MODE USER. Note: This value also applies to the step width of the rotary knob on the instrument and,
in user-defined step mode, increases or decreases the frequency.
:param increment: float Range: 0 Hz to RFmax - 100 kHz
"""
param = Conversions.decimal_value_to_str(increment)
self._core.io.write(f'SOURce<HwInstance>:FREQuency:STEP:INCRement {param}')