from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class ClippingCls:
"""
| Commands in total: 4
| Subgroups: 0
| Direct child commands: 4
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("clipping", core, parent)
[docs]
def get_level(self) -> int:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:LEVel`` \n
Snippet: ``value: int = driver.source.bb.wlnn.clipping.get_level()`` \n
Sets the limit for level clipping. This value indicates at what point the signal is clipped. It is specified as a
percentage, relative to the highest level. 100% indicates that clipping does not take place. Level clipping is activated
if method ``RsSmw.source.bb.wlnn.clipping.state()`` is set to ON.
:return: level: integer Range: 1 PCT to 100 PCT
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:WLNN:CLIPping:LEVel?')
return Conversions.str_to_int(response)
[docs]
def set_level(self, level: int) -> None:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:LEVel`` \n
Snippet: ``driver.source.bb.wlnn.clipping.set_level(level = 1)`` \n
Sets the limit for level clipping. This value indicates at what point the signal is clipped. It is specified as a
percentage, relative to the highest level. 100% indicates that clipping does not take place. Level clipping is activated
if method ``RsSmw.source.bb.wlnn.clipping.state()`` is set to ON.
:param level: integer Range: 1 PCT to 100 PCT
"""
param = Conversions.decimal_value_to_str(level)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:CLIPping:LEVel {param}')
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.ClipMode:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:MODE`` \n
Snippet: ``value: enums.ClipMode = driver.source.bb.wlnn.clipping.get_mode()`` \n
Sets the method for level clipping.
:return: mode: VECTor | SCALar VECTor The reference level is the amplitude i+jq. SCALar The reference level is the absolute maximum of the I and Q values.
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:WLNN:CLIPping:MODE?')
return Conversions.str_to_scalar_enum(response, enums.ClipMode)
[docs]
def set_mode(self, mode: enums.ClipMode) -> None:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:MODE`` \n
Snippet: ``driver.source.bb.wlnn.clipping.set_mode(mode = enums.ClipMode.SCALar)`` \n
Sets the method for level clipping.
:param mode: VECTor | SCALar VECTor The reference level is the amplitude i+jq. SCALar The reference level is the absolute maximum of the I and Q values.
"""
param = Conversions.enum_scalar_to_str(mode, enums.ClipMode)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:CLIPping:MODE {param}')
[docs]
def get_spps_state(self) -> bool:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:SPPState`` \n
Snippet: ``value: bool = driver.source.bb.wlnn.clipping.get_spps_state()`` \n
Applies vector clipping to fields L-SIG, RL-SIG, U-SIG and EHT-SIG.
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:WLNN:CLIPping:SPPState?')
return Conversions.str_to_bool(response)
[docs]
def set_spps_state(self, state: bool) -> None:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:SPPState`` \n
Snippet: ``driver.source.bb.wlnn.clipping.set_spps_state(state = False)`` \n
Applies vector clipping to fields L-SIG, RL-SIG, U-SIG and EHT-SIG.
:param state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:CLIPping:SPPState {param}')
[docs]
def get_state(self) -> bool:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:STATe`` \n
Snippet: ``value: bool = driver.source.bb.wlnn.clipping.get_state()`` \n
Activates level clipping (Clipping) . The value is defined with method ``RsSmw.source.bb.wlnn.clipping.level()`` , the
mode of calculation with method ``RsSmw.source.bb.wlnn.clipping.mode()`` .
:return: state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:WLNN:CLIPping:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""
``[SOURce<HW>]:BB:WLNN:CLIPping:STATe`` \n
Snippet: ``driver.source.bb.wlnn.clipping.set_state(state = False)`` \n
Activates level clipping (Clipping) . The value is defined with method ``RsSmw.source.bb.wlnn.clipping.level()`` , the
mode of calculation with method ``RsSmw.source.bb.wlnn.clipping.mode()`` .
:param state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:WLNN:CLIPping:STATe {param}')