from ........Internal.Core import Core
from ........Internal.CommandsGroup import CommandsGroup
from ........Internal import Conversions
from ........ import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class DetroughingCls:
"""
| Commands in total: 4
| Subgroups: 0
| Direct child commands: 4
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("detroughing", core, parent)
[docs]
def get_coupling(self) -> bool:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:COUPling`` \n
Snippet: ``value: bool = driver.source.iq.output.analog.envelope.shaping.detroughing.get_coupling()`` \n
Enables/disables deriving the detroughing factor (d) from the selected Vcc value.
:return: coupling_state: 1 | ON | 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:COUPling?')
return Conversions.str_to_bool(response)
[docs]
def set_coupling(self, coupling_state: bool) -> None:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:COUPling`` \n
Snippet: ``driver.source.iq.output.analog.envelope.shaping.detroughing.set_coupling(coupling_state = False)`` \n
Enables/disables deriving the detroughing factor (d) from the selected Vcc value.
:param coupling_state: 1 | ON | 0| OFF
"""
param = Conversions.bool_to_str(coupling_state)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:COUPling {param}')
[docs]
def get_factor(self) -> float:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:FACTor`` \n
Snippet: ``value: float = driver.source.iq.output.analog.envelope.shaping.detroughing.get_factor()`` \n
Sets the detroughing factor.
:return: detr_factor: float Range: 0 to 2
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:FACTor?')
return Conversions.str_to_float(response)
[docs]
def set_factor(self, detr_factor: float) -> None:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:FACTor`` \n
Snippet: ``driver.source.iq.output.analog.envelope.shaping.detroughing.set_factor(detr_factor = 1.0)`` \n
Sets the detroughing factor.
:param detr_factor: float Range: 0 to 2
"""
param = Conversions.decimal_value_to_str(detr_factor)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:FACTor {param}')
# noinspection PyTypeChecker
[docs]
def get_function(self) -> enums.IqOutEnvDetrFunc:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:FUNCtion`` \n
Snippet: ``value: enums.IqOutEnvDetrFunc = driver.source.iq.output.analog.envelope.shaping.detroughing.get_function()`` \n
Sets the detroughing function.
:return: detr_function: F1 | F2 | F3
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:FUNCtion?')
return Conversions.str_to_scalar_enum(response, enums.IqOutEnvDetrFunc)
[docs]
def set_function(self, detr_function: enums.IqOutEnvDetrFunc) -> None:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:FUNCtion`` \n
Snippet: ``driver.source.iq.output.analog.envelope.shaping.detroughing.set_function(detr_function = enums.IqOutEnvDetrFunc.F1)`` \n
Sets the detroughing function.
:param detr_function: F1 | F2 | F3
"""
param = Conversions.enum_scalar_to_str(detr_function, enums.IqOutEnvDetrFunc)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:FUNCtion {param}')
[docs]
def get_pexponent(self) -> float:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:PEXPonent`` \n
Snippet: ``value: float = driver.source.iq.output.analog.envelope.shaping.detroughing.get_pexponent()`` \n
Sets the exponent (a) for the detroughing function F3.
:return: power_exponent: float Range: 1 to 10
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:PEXPonent?')
return Conversions.str_to_float(response)
[docs]
def set_pexponent(self, power_exponent: float) -> None:
"""
``[SOURce<HW>]:IQ:OUTPut:[ANALog]:ENVelope:SHAPing:DETRoughing:PEXPonent`` \n
Snippet: ``driver.source.iq.output.analog.envelope.shaping.detroughing.set_pexponent(power_exponent = 1.0)`` \n
Sets the exponent (a) for the detroughing function F3.
:param power_exponent: float Range: 1 to 10
"""
param = Conversions.decimal_value_to_str(power_exponent)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:ENVelope:SHAPing:DETRoughing:PEXPonent {param}')