from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class ClippingCls:
"""Clipping commands group definition. 3 total commands, 0 Subgroups, 3 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("clipping", core, parent)
[docs] def get_level(self) -> int:
"""SCPI: [SOURce<HW>]:BB:W3GPp:CLIPping:LEVel \n
Snippet: value: int = driver.source.bb.w3Gpp.clipping.get_level() \n
The command sets the limit for level clipping (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 with the command SOUR:BB:W3GP:CLIP:STAT ON \n
:return: level: integer Range: 1 to 100
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:CLIPping:LEVel?')
return Conversions.str_to_int(response)
[docs] def set_level(self, level: int) -> None:
"""SCPI: [SOURce<HW>]:BB:W3GPp:CLIPping:LEVel \n
Snippet: driver.source.bb.w3Gpp.clipping.set_level(level = 1) \n
The command sets the limit for level clipping (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 with the command SOUR:BB:W3GP:CLIP:STAT ON \n
:param level: integer Range: 1 to 100
"""
param = Conversions.decimal_value_to_str(level)
self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:CLIPping:LEVel {param}')
# noinspection PyTypeChecker
[docs] def get_mode(self) -> enums.ClipMode:
"""SCPI: [SOURce<HW>]:BB:W3GPp:CLIPping:MODE \n
Snippet: value: enums.ClipMode = driver.source.bb.w3Gpp.clipping.get_mode() \n
The command sets the method for level clipping (Clipping) . \n
: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:W3GPp:CLIPping:MODE?')
return Conversions.str_to_scalar_enum(response, enums.ClipMode)
[docs] def set_mode(self, mode: enums.ClipMode) -> None:
"""SCPI: [SOURce<HW>]:BB:W3GPp:CLIPping:MODE \n
Snippet: driver.source.bb.w3Gpp.clipping.set_mode(mode = enums.ClipMode.SCALar) \n
The command sets the method for level clipping (Clipping) . \n
: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:W3GPp:CLIPping:MODE {param}')
[docs] def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:BB:W3GPp:CLIPping:STATe \n
Snippet: value: bool = driver.source.bb.w3Gpp.clipping.get_state() \n
Activates level clipping. \n
:return: state: 1| ON| 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:BB:W3GPp:CLIPping:STATe?')
return Conversions.str_to_bool(response)
[docs] def set_state(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:BB:W3GPp:CLIPping:STATe \n
Snippet: driver.source.bb.w3Gpp.clipping.set_state(state = False) \n
Activates level clipping. \n
:param state: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:BB:W3GPp:CLIPping:STATe {param}')