from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class FrequencyCls:
"""Frequency commands group definition. 19 total commands, 5 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("frequency", core, parent)
@property
def reference(self):
"""reference commands group. 1 Sub-classes, 0 commands."""
if not hasattr(self, '_reference'):
from .Reference import ReferenceCls
self._reference = ReferenceCls(self._core, self._cmd_group)
return self._reference
@property
def spacing(self):
"""spacing commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_spacing'):
from .Spacing import SpacingCls
self._spacing = SpacingCls(self._core, self._cmd_group)
return self._spacing
@property
def timing(self):
"""timing commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_timing'):
from .Timing import TimingCls
self._timing = TimingCls(self._core, self._cmd_group)
return self._timing
@property
def yscale(self):
"""yscale commands group. 1 Sub-classes, 2 commands."""
if not hasattr(self, '_yscale'):
from .Yscale import YscaleCls
self._yscale = YscaleCls(self._core, self._cmd_group)
return self._yscale
@property
def sensor(self):
"""sensor commands group. 2 Sub-classes, 0 commands."""
if not hasattr(self, '_sensor'):
from .Sensor import SensorCls
self._sensor = SensorCls(self._core, self._cmd_group)
return self._sensor
# noinspection PyTypeChecker
[docs]
def get_rmode(self) -> enums.RepeatMode:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:RMODe \n
Snippet: value: enums.RepeatMode = driver.sense.power.sweep.frequency.get_rmode() \n
Selects single or continuous mode for measurement mode frequency in power analysis. \n
:return: rmode: SINGle| CONTinuous
"""
response = self._core.io.query_str('SENSe:POWer:SWEep:FREQuency:RMODe?')
return Conversions.str_to_scalar_enum(response, enums.RepeatMode)
[docs]
def set_rmode(self, rmode: enums.RepeatMode) -> None:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:RMODe \n
Snippet: driver.sense.power.sweep.frequency.set_rmode(rmode = enums.RepeatMode.CONTinuous) \n
Selects single or continuous mode for measurement mode frequency in power analysis. \n
:param rmode: SINGle| CONTinuous
"""
param = Conversions.enum_scalar_to_str(rmode, enums.RepeatMode)
self._core.io.write(f'SENSe:POWer:SWEep:FREQuency:RMODe {param}')
[docs]
def get_start(self) -> float:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:STARt \n
Snippet: value: float = driver.sense.power.sweep.frequency.get_start() \n
Sets the start frequency for the frequency mode. \n
:return: start: float Range: 0 to 1E12
"""
response = self._core.io.query_str('SENSe:POWer:SWEep:FREQuency:STARt?')
return Conversions.str_to_float(response)
[docs]
def set_start(self, start: float) -> None:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:STARt \n
Snippet: driver.sense.power.sweep.frequency.set_start(start = 1.0) \n
Sets the start frequency for the frequency mode. \n
:param start: float Range: 0 to 1E12
"""
param = Conversions.decimal_value_to_str(start)
self._core.io.write(f'SENSe:POWer:SWEep:FREQuency:STARt {param}')
[docs]
def get_steps(self) -> int:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:STEPs \n
Snippet: value: int = driver.sense.power.sweep.frequency.get_steps() \n
Sets the number of measurement steps for the frequency mode. \n
:return: steps: integer Range: 10 to 1000
"""
response = self._core.io.query_str('SENSe:POWer:SWEep:FREQuency:STEPs?')
return Conversions.str_to_int(response)
[docs]
def set_steps(self, steps: int) -> None:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:STEPs \n
Snippet: driver.sense.power.sweep.frequency.set_steps(steps = 1) \n
Sets the number of measurement steps for the frequency mode. \n
:param steps: integer Range: 10 to 1000
"""
param = Conversions.decimal_value_to_str(steps)
self._core.io.write(f'SENSe:POWer:SWEep:FREQuency:STEPs {param}')
[docs]
def get_stop(self) -> float:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:STOP \n
Snippet: value: float = driver.sense.power.sweep.frequency.get_stop() \n
Sets the stop frequency for the frequency mode. \n
:return: stop: float Range: 0 to 1E12
"""
response = self._core.io.query_str('SENSe:POWer:SWEep:FREQuency:STOP?')
return Conversions.str_to_float(response)
[docs]
def set_stop(self, stop: float) -> None:
"""SCPI: SENSe:[POWer]:SWEep:FREQuency:STOP \n
Snippet: driver.sense.power.sweep.frequency.set_stop(stop = 1.0) \n
Sets the stop frequency for the frequency mode. \n
:param stop: float Range: 0 to 1E12
"""
param = Conversions.decimal_value_to_str(stop)
self._core.io.write(f'SENSe:POWer:SWEep:FREQuency:STOP {param}')
def clone(self) -> 'FrequencyCls':
"""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 = FrequencyCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group