Source code for rsmxo.Implementations.Calculate.Spectrum.Magnitude.Scale

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
from ..... import repcap


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ScaleCls:
	"""
	| Commands in total: 1
	| Subgroups: 0
	| Direct child commands: 1
	"""

	def __init__(self, core: Core, parent):
		self._core = core
		self._cmd_group = CommandsGroup("scale", core, parent)

[docs] def set(self, unit: enums.MagnitudeUnit, spectrum=repcap.Spectrum.Default) -> None: """ ``CALCulate:SPECtrum<*>:MAGNitude:SCALe`` \n Snippet: ``driver.calculate.spectrum.magnitude.scale.set(unit = enums.MagnitudeUnit.DB, spectrum = repcap.Spectrum.Default)`` \n Sets the unit for the y-axis. :param unit: LINear | DB | DBM | DBV | DBUV | DBS | DBHZ :param spectrum: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Spectrum') """ param = Conversions.enum_scalar_to_str(unit, enums.MagnitudeUnit) spectrum_cmd_val = self._cmd_group.get_repcap_cmd_value(spectrum, repcap.Spectrum) self._core.io.write(f'CALCulate:SPECtrum{spectrum_cmd_val}:MAGNitude:SCALe {param}')
# noinspection PyTypeChecker
[docs] def get(self, spectrum=repcap.Spectrum.Default) -> enums.MagnitudeUnit: """ ``CALCulate:SPECtrum<*>:MAGNitude:SCALe`` \n Snippet: ``value: enums.MagnitudeUnit = driver.calculate.spectrum.magnitude.scale.get(spectrum = repcap.Spectrum.Default)`` \n Sets the unit for the y-axis. :param spectrum: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Spectrum') :return: unit: LINear | DB | DBM | DBV | DBUV | DBS | DBHZ """ spectrum_cmd_val = self._cmd_group.get_repcap_cmd_value(spectrum, repcap.Spectrum) response = self._core.io.query_str(f'CALCulate:SPECtrum{spectrum_cmd_val}:MAGNitude:SCALe?') return Conversions.str_to_scalar_enum(response, enums.MagnitudeUnit)