from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class RfSettingsCls:
"""RfSettings commands group definition. 6 total commands, 0 Subgroups, 6 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("rfSettings", core, parent)
[docs]
def get_eattenuation(self) -> float:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:EATTenuation \n
Snippet: value: float = driver.configure.nrSubMeas.rfSettings.get_eattenuation() \n
Defines an external attenuation (or gain, if the value is negative) , to be applied to the input connector. \n
:return: rf_input_ext_att: numeric External attenuation Range: -50 dB to 90 dB, Unit: dB
"""
response = self._core.io.query_str('CONFigure:NRSub:MEASurement<Instance>:RFSettings:EATTenuation?')
return Conversions.str_to_float(response)
[docs]
def set_eattenuation(self, rf_input_ext_att: float) -> None:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:EATTenuation \n
Snippet: driver.configure.nrSubMeas.rfSettings.set_eattenuation(rf_input_ext_att = 1.0) \n
Defines an external attenuation (or gain, if the value is negative) , to be applied to the input connector. \n
:param rf_input_ext_att: numeric External attenuation Range: -50 dB to 90 dB, Unit: dB
"""
param = Conversions.decimal_value_to_str(rf_input_ext_att)
self._core.io.write(f'CONFigure:NRSub:MEASurement<Instance>:RFSettings:EATTenuation {param}')
[docs]
def get_umargin(self) -> float:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:UMARgin \n
Snippet: value: float = driver.configure.nrSubMeas.rfSettings.get_umargin() \n
Sets the margin that the measurement adds to the expected nominal power to determine the reference power. The reference
power minus the external input attenuation must be within the power range of the selected input connector. Refer to the
specifications document. \n
:return: user_margin: numeric Range: 0 dB to (55 dB + external attenuation - expected nominal power) , Unit: dB
"""
response = self._core.io.query_str('CONFigure:NRSub:MEASurement<Instance>:RFSettings:UMARgin?')
return Conversions.str_to_float(response)
[docs]
def set_umargin(self, user_margin: float) -> None:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:UMARgin \n
Snippet: driver.configure.nrSubMeas.rfSettings.set_umargin(user_margin = 1.0) \n
Sets the margin that the measurement adds to the expected nominal power to determine the reference power. The reference
power minus the external input attenuation must be within the power range of the selected input connector. Refer to the
specifications document. \n
:param user_margin: numeric Range: 0 dB to (55 dB + external attenuation - expected nominal power) , Unit: dB
"""
param = Conversions.decimal_value_to_str(user_margin)
self._core.io.write(f'CONFigure:NRSub:MEASurement<Instance>:RFSettings:UMARgin {param}')
[docs]
def get_envelope_power(self) -> float:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:ENPower \n
Snippet: value: float = driver.configure.nrSubMeas.rfSettings.get_envelope_power() \n
Sets the expected nominal power of the measured RF signal. \n
:return: exp_nom_pow: numeric The range of the expected nominal power can be calculated as follows: Range (Expected Nominal Power) = Range (Input Power) + External Attenuation - User Margin The input power range is stated in the specifications document. Unit: dBm
"""
response = self._core.io.query_str('CONFigure:NRSub:MEASurement<Instance>:RFSettings:ENPower?')
return Conversions.str_to_float(response)
[docs]
def set_envelope_power(self, exp_nom_pow: float) -> None:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:ENPower \n
Snippet: driver.configure.nrSubMeas.rfSettings.set_envelope_power(exp_nom_pow = 1.0) \n
Sets the expected nominal power of the measured RF signal. \n
:param exp_nom_pow: numeric The range of the expected nominal power can be calculated as follows: Range (Expected Nominal Power) = Range (Input Power) + External Attenuation - User Margin The input power range is stated in the specifications document. Unit: dBm
"""
param = Conversions.decimal_value_to_str(exp_nom_pow)
self._core.io.write(f'CONFigure:NRSub:MEASurement<Instance>:RFSettings:ENPower {param}')
[docs]
def get_frequency(self) -> float:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:FREQuency \n
Snippet: value: float = driver.configure.nrSubMeas.rfSettings.get_frequency() \n
No command help available \n
:return: analyzer_freq: No help available
"""
response = self._core.io.query_str('CONFigure:NRSub:MEASurement<Instance>:RFSettings:FREQuency?')
return Conversions.str_to_float(response)
[docs]
def set_frequency(self, analyzer_freq: float) -> None:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:FREQuency \n
Snippet: driver.configure.nrSubMeas.rfSettings.set_frequency(analyzer_freq = 1.0) \n
No command help available \n
:param analyzer_freq: No help available
"""
param = Conversions.decimal_value_to_str(analyzer_freq)
self._core.io.write(f'CONFigure:NRSub:MEASurement<Instance>:RFSettings:FREQuency {param}')
[docs]
def get_foffset(self) -> int:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:FOFFset \n
Snippet: value: int = driver.configure.nrSubMeas.rfSettings.get_foffset() \n
Specifies a positive or negative frequency offset to be added to the carrier center frequency (method RsCmwNrFr1Meas.
Configure.NrSubMeas.Cc.Frequency.set) . \n
:return: offset: numeric Range: -100 kHz to 100 kHz, Unit: Hz
"""
response = self._core.io.query_str_with_opc('CONFigure:NRSub:MEASurement<Instance>:RFSettings:FOFFset?')
return Conversions.str_to_int(response)
[docs]
def set_foffset(self, offset: int) -> None:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:FOFFset \n
Snippet: driver.configure.nrSubMeas.rfSettings.set_foffset(offset = 1) \n
Specifies a positive or negative frequency offset to be added to the carrier center frequency (method RsCmwNrFr1Meas.
Configure.NrSubMeas.Cc.Frequency.set) . \n
:param offset: numeric Range: -100 kHz to 100 kHz, Unit: Hz
"""
param = Conversions.decimal_value_to_str(offset)
self._core.io.write_with_opc(f'CONFigure:NRSub:MEASurement<Instance>:RFSettings:FOFFset {param}')
[docs]
def get_ml_offset(self) -> float:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:MLOFfset \n
Snippet: value: float = driver.configure.nrSubMeas.rfSettings.get_ml_offset() \n
Varies the input level of the mixer in the analyzer path. \n
:return: mix_lev_offset: numeric Range: -10 dB to 10 dB, Unit: dB
"""
response = self._core.io.query_str('CONFigure:NRSub:MEASurement<Instance>:RFSettings:MLOFfset?')
return Conversions.str_to_float(response)
[docs]
def set_ml_offset(self, mix_lev_offset: float) -> None:
"""SCPI: CONFigure:NRSub:MEASurement<Instance>:RFSettings:MLOFfset \n
Snippet: driver.configure.nrSubMeas.rfSettings.set_ml_offset(mix_lev_offset = 1.0) \n
Varies the input level of the mixer in the analyzer path. \n
:param mix_lev_offset: numeric Range: -10 dB to 10 dB, Unit: dB
"""
param = Conversions.decimal_value_to_str(mix_lev_offset)
self._core.io.write(f'CONFigure:NRSub:MEASurement<Instance>:RFSettings:MLOFfset {param}')