from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions
from ..... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class DepthCls:
"""Depth commands group definition. 4 total commands, 2 Subgroups, 2 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("depth", core, parent)
@property
def exponential(self):
"""exponential commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_exponential'):
from .Exponential import ExponentialCls
self._exponential = ExponentialCls(self._core, self._cmd_group)
return self._exponential
@property
def linear(self):
"""linear commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_linear'):
from .Linear import LinearCls
self._linear = LinearCls(self._core, self._cmd_group)
return self._linear
[docs]
def get_sum(self) -> float:
"""SCPI: [SOURce<HW>]:AM:DEPTh:SUM \n
Snippet: value: float = driver.source.am.depth.get_sum() \n
Sets the total depth of the LF signal when using combined signal sources in amplitude modulation. \n
:return: am_depth_sum: float Range: 0 to 100
"""
response = self._core.io.query_str('SOURce<HwInstance>:AM:DEPTh:SUM?')
return Conversions.str_to_float(response)
[docs]
def set_sum(self, am_depth_sum: float) -> None:
"""SCPI: [SOURce<HW>]:AM:DEPTh:SUM \n
Snippet: driver.source.am.depth.set_sum(am_depth_sum = 1.0) \n
Sets the total depth of the LF signal when using combined signal sources in amplitude modulation. \n
:param am_depth_sum: float Range: 0 to 100
"""
param = Conversions.decimal_value_to_str(am_depth_sum)
self._core.io.write(f'SOURce<HwInstance>:AM:DEPTh:SUM {param}')
[docs]
def set(self, depth: float, generatorIx=repcap.GeneratorIx.Default) -> None:
"""SCPI: [SOURce<HW>]:AM<CH>:[DEPTh] \n
Snippet: driver.source.am.depth.set(depth = 1.0, generatorIx = repcap.GeneratorIx.Default) \n
Sets the depth of the amplitude modulation in percent. \n
:param depth: float Range: 0 to 100
:param generatorIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Am')
"""
param = Conversions.decimal_value_to_str(depth)
generatorIx_cmd_val = self._cmd_group.get_repcap_cmd_value(generatorIx, repcap.GeneratorIx)
self._core.io.write(f'SOURce<HwInstance>:AM{generatorIx_cmd_val}:DEPTh {param}')
[docs]
def get(self, generatorIx=repcap.GeneratorIx.Default) -> float:
"""SCPI: [SOURce<HW>]:AM<CH>:[DEPTh] \n
Snippet: value: float = driver.source.am.depth.get(generatorIx = repcap.GeneratorIx.Default) \n
Sets the depth of the amplitude modulation in percent. \n
:param generatorIx: optional repeated capability selector. Default value: Nr1 (settable in the interface 'Am')
:return: depth: float Range: 0 to 100"""
generatorIx_cmd_val = self._cmd_group.get_repcap_cmd_value(generatorIx, repcap.GeneratorIx)
response = self._core.io.query_str(f'SOURce<HwInstance>:AM{generatorIx_cmd_val}:DEPTh?')
return Conversions.str_to_float(response)
def clone(self) -> 'DepthCls':
"""Clones the group by creating new object from it and its whole existing subgroups
Also copies all the existing default Repeated Capabilities setting,
which you can change independently without affecting the original group"""
new_group = DepthCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group