from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.StructBase import StructBase
from ....Internal.ArgStruct import ArgStruct
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class Limit:
"""Limit commands group definition. 13 total commands, 1 Sub-groups, 6 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._base = CommandsGroup("limit", core, parent)
@property
def pcontrol(self):
"""pcontrol commands group. 1 Sub-classes, 3 commands."""
if not hasattr(self, '_pcontrol'):
from .Limit_.Pcontrol import Pcontrol
self._pcontrol = Pcontrol(self._core, self._base)
return self._pcontrol
# noinspection PyTypeChecker
[docs] class EvMagnitudeStruct(StructBase):
"""Structure for reading output parameters. Fields: \n
- Rms: float or bool: numeric | ON | OFF Range: 0 % to 99 %, Unit: % Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
- Peak: float or bool: numeric | ON | OFF Range: 0 % to 99 %, Unit: % Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)"""
__meta_args_list = [
ArgStruct.scalar_float_ext('Rms'),
ArgStruct.scalar_float_ext('Peak')]
def __init__(self):
StructBase.__init__(self, self)
self.Rms: float or bool = None
self.Peak: float or bool = None
[docs] def get_ev_magnitude(self) -> EvMagnitudeStruct:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:EVMagnitude \n
Snippet: value: EvMagnitudeStruct = driver.configure.prach.limit.get_ev_magnitude() \n
Defines upper limits for the RMS and peak values of the error vector magnitude (EVM) . \n
:return: structure: for return value, see the help for EvMagnitudeStruct structure arguments.
"""
return self._core.io.query_struct('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:EVMagnitude?', self.__class__.EvMagnitudeStruct())
[docs] def set_ev_magnitude(self, value: EvMagnitudeStruct) -> None:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:EVMagnitude \n
Snippet: driver.configure.prach.limit.set_ev_magnitude(value = EvMagnitudeStruct()) \n
Defines upper limits for the RMS and peak values of the error vector magnitude (EVM) . \n
:param value: see the help for EvMagnitudeStruct structure arguments.
"""
self._core.io.write_struct('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:EVMagnitude', value)
# noinspection PyTypeChecker
[docs] class MerrorStruct(StructBase):
"""Structure for reading output parameters. Fields: \n
- Rms: float or bool: numeric | ON | OFF Range: 0 % to 99 %, Unit: % Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
- Peak: float or bool: numeric | ON | OFF Range: 0 % to 99 %, Unit: % Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)"""
__meta_args_list = [
ArgStruct.scalar_float_ext('Rms'),
ArgStruct.scalar_float_ext('Peak')]
def __init__(self):
StructBase.__init__(self, self)
self.Rms: float or bool = None
self.Peak: float or bool = None
[docs] def get_merror(self) -> MerrorStruct:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:MERRor \n
Snippet: value: MerrorStruct = driver.configure.prach.limit.get_merror() \n
Defines upper limits for the RMS and peak values of the magnitude error. \n
:return: structure: for return value, see the help for MerrorStruct structure arguments.
"""
return self._core.io.query_struct('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:MERRor?', self.__class__.MerrorStruct())
[docs] def set_merror(self, value: MerrorStruct) -> None:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:MERRor \n
Snippet: driver.configure.prach.limit.set_merror(value = MerrorStruct()) \n
Defines upper limits for the RMS and peak values of the magnitude error. \n
:param value: see the help for MerrorStruct structure arguments.
"""
self._core.io.write_struct('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:MERRor', value)
# noinspection PyTypeChecker
[docs] class PerrorStruct(StructBase):
"""Structure for reading output parameters. Fields: \n
- Rms: float or bool: numeric | ON | OFF Range: 0 deg to 45 deg, Unit: deg Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
- Peak: float or bool: numeric | ON | OFF Range: 0 deg to 45 deg, Unit: deg Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)"""
__meta_args_list = [
ArgStruct.scalar_float_ext('Rms'),
ArgStruct.scalar_float_ext('Peak')]
def __init__(self):
StructBase.__init__(self, self)
self.Rms: float or bool = None
self.Peak: float or bool = None
[docs] def get_perror(self) -> PerrorStruct:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:PERRor \n
Snippet: value: PerrorStruct = driver.configure.prach.limit.get_perror() \n
Defines symmetric limits for the RMS and peak values of the phase error. The limit check fails the UE if the absolute
value of the measured phase error exceeds the specified values. \n
:return: structure: for return value, see the help for PerrorStruct structure arguments.
"""
return self._core.io.query_struct('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:PERRor?', self.__class__.PerrorStruct())
[docs] def set_perror(self, value: PerrorStruct) -> None:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:PERRor \n
Snippet: driver.configure.prach.limit.set_perror(value = PerrorStruct()) \n
Defines symmetric limits for the RMS and peak values of the phase error. The limit check fails the UE if the absolute
value of the measured phase error exceeds the specified values. \n
:param value: see the help for PerrorStruct structure arguments.
"""
self._core.io.write_struct('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:PERRor', value)
[docs] def get_iq_offset(self) -> float or bool:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:IQOFfset \n
Snippet: value: float or bool = driver.configure.prach.limit.get_iq_offset() \n
Defines an upper limit for the I/Q origin offset. \n
:return: iq_offset: numeric | ON | OFF Range: -80 dB to 0 dB, Unit: dB Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
"""
response = self._core.io.query_str('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:IQOFfset?')
return Conversions.str_to_float_or_bool(response)
[docs] def set_iq_offset(self, iq_offset: float or bool) -> None:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:IQOFfset \n
Snippet: driver.configure.prach.limit.set_iq_offset(iq_offset = 1.0) \n
Defines an upper limit for the I/Q origin offset. \n
:param iq_offset: numeric | ON | OFF Range: -80 dB to 0 dB, Unit: dB Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
"""
param = Conversions.decimal_or_bool_value_to_str(iq_offset)
self._core.io.write(f'CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:IQOFfset {param}')
[docs] def get_iq_imbalance(self) -> float or bool:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:IQIMbalance \n
Snippet: value: float or bool = driver.configure.prach.limit.get_iq_imbalance() \n
Defines an upper limit for the I/Q imbalance. \n
:return: iq_imbalance: numeric | ON | OFF Range: -99 dB to 0 dB, Unit: dB Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
"""
response = self._core.io.query_str('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:IQIMbalance?')
return Conversions.str_to_float_or_bool(response)
[docs] def set_iq_imbalance(self, iq_imbalance: float or bool) -> None:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:IQIMbalance \n
Snippet: driver.configure.prach.limit.set_iq_imbalance(iq_imbalance = 1.0) \n
Defines an upper limit for the I/Q imbalance. \n
:param iq_imbalance: numeric | ON | OFF Range: -99 dB to 0 dB, Unit: dB Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
"""
param = Conversions.decimal_or_bool_value_to_str(iq_imbalance)
self._core.io.write(f'CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:IQIMbalance {param}')
[docs] def get_cf_error(self) -> float or bool:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:CFERror \n
Snippet: value: float or bool = driver.configure.prach.limit.get_cf_error() \n
Defines an upper limit for the carrier frequency error. \n
:return: frequency_error: numeric | ON | OFF Range: 0 Hz to 4000 Hz, Unit: Hz Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
"""
response = self._core.io.query_str('CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:CFERror?')
return Conversions.str_to_float_or_bool(response)
[docs] def set_cf_error(self, frequency_error: float or bool) -> None:
"""SCPI: CONFigure:WCDMa:MEASurement<instance>:PRACh:LIMit:CFERror \n
Snippet: driver.configure.prach.limit.set_cf_error(frequency_error = 1.0) \n
Defines an upper limit for the carrier frequency error. \n
:param frequency_error: numeric | ON | OFF Range: 0 Hz to 4000 Hz, Unit: Hz Additional parameters: OFF | ON (disables the limit check | enables the limit check using the previous/default limit values)
"""
param = Conversions.decimal_or_bool_value_to_str(frequency_error)
self._core.io.write(f'CONFigure:WCDMa:MEASurement<Instance>:PRACh:LIMit:CFERror {param}')
def clone(self) -> 'Limit':
"""Clones the group by creating new object from it and its whole existing sub-groups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = Limit(self._core, self._base.parent)
self._base.synchronize_repcaps(new_group)
return new_group