from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class AnalogCls:
"""Analog commands group definition. 63 total commands, 5 Subgroups, 6 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("analog", core, parent)
@property
def bias(self):
"""bias commands group. 1 Sub-classes, 2 commands."""
if not hasattr(self, '_bias'):
from .Bias import BiasCls
self._bias = BiasCls(self._core, self._cmd_group)
return self._bias
@property
def envelope(self):
"""envelope commands group. 7 Sub-classes, 12 commands."""
if not hasattr(self, '_envelope'):
from .Envelope import EnvelopeCls
self._envelope = EnvelopeCls(self._core, self._cmd_group)
return self._envelope
@property
def offset(self):
"""offset commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_offset'):
from .Offset import OffsetCls
self._offset = OffsetCls(self._core, self._cmd_group)
return self._offset
@property
def ppsMarker(self):
"""ppsMarker commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_ppsMarker'):
from .PpsMarker import PpsMarkerCls
self._ppsMarker = PpsMarkerCls(self._core, self._cmd_group)
return self._ppsMarker
@property
def setting(self):
"""setting commands group. 0 Sub-classes, 4 commands."""
if not hasattr(self, '_setting'):
from .Setting import SettingCls
self._setting = SettingCls(self._core, self._cmd_group)
return self._setting
[docs]
def get_state(self) -> bool:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:ANALog:STATe \n
Snippet: value: bool = driver.source.iq.output.analog.get_state() \n
Activates the specified analog I/Q output. Note: By default, the output connectors [I/Q Out x] are deactivated. \n
:return: state: 1| ON| 0| OFF
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:STATe?')
return Conversions.str_to_bool(response)
[docs]
def set_state(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:ANALog:STATe \n
Snippet: driver.source.iq.output.analog.set_state(state = False) \n
Activates the specified analog I/Q output. Note: By default, the output connectors [I/Q Out x] are deactivated. \n
:param state: 1| ON| 0| OFF
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:STATe {param}')
[docs]
def get_hp_marker(self) -> bool:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:HPMarker \n
Snippet: value: bool = driver.source.iq.output.analog.get_hp_marker() \n
No command help available \n
:return: state: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:HPMarker?')
return Conversions.str_to_bool(response)
[docs]
def set_hp_marker(self, state: bool) -> None:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:HPMarker \n
Snippet: driver.source.iq.output.analog.set_hp_marker(state = False) \n
No command help available \n
:param state: No help available
"""
param = Conversions.bool_to_str(state)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:HPMarker {param}')
# noinspection PyTypeChecker
[docs]
def get_mode(self) -> enums.IqOutMode:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:MODE \n
Snippet: value: enums.IqOutMode = driver.source.iq.output.analog.get_mode() \n
Determines the mode for setting the output parameters. \n
:return: mode: FIXed| VARiable FIXed Locks the I/Q output settings VARiable Unlocks the settings
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:MODE?')
return Conversions.str_to_scalar_enum(response, enums.IqOutMode)
[docs]
def set_mode(self, mode: enums.IqOutMode) -> None:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:MODE \n
Snippet: driver.source.iq.output.analog.set_mode(mode = enums.IqOutMode.FIXed) \n
Determines the mode for setting the output parameters. \n
:param mode: FIXed| VARiable FIXed Locks the I/Q output settings VARiable Unlocks the settings
"""
param = Conversions.enum_scalar_to_str(mode, enums.IqOutMode)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:MODE {param}')
# noinspection PyTypeChecker
[docs]
def get_polarization(self) -> enums.IqOutPol:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:POLarization \n
Snippet: value: enums.IqOutPol = driver.source.iq.output.analog.get_polarization() \n
No command help available \n
:return: ipartq_polarization: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:POLarization?')
return Conversions.str_to_scalar_enum(response, enums.IqOutPol)
[docs]
def set_polarization(self, ipartq_polarization: enums.IqOutPol) -> None:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:POLarization \n
Snippet: driver.source.iq.output.analog.set_polarization(ipartq_polarization = enums.IqOutPol.BIPolar) \n
No command help available \n
:param ipartq_polarization: No help available
"""
param = Conversions.enum_scalar_to_str(ipartq_polarization, enums.IqOutPol)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:POLarization {param}')
[docs]
def preset(self) -> None:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:PRESet \n
Snippet: driver.source.iq.output.analog.preset() \n
Sets the default settings (*RST values specified for the commands) .
INTRO_CMD_HELP: Not affected are: \n
- The state set with the command [:SOURce<hw>]:IQ:OUTPut:ANALog:STATe.
- If SCONfiguration:EXTernal:PBEHaviour 1, the I/Q ouptput type set with the command [:SOURce<hw>]:IQ:OUTPut[:ANALog]:TYPE. \n
"""
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:PRESet')
[docs]
def preset_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:PRESet \n
Snippet: driver.source.iq.output.analog.preset_with_opc() \n
Sets the default settings (*RST values specified for the commands) .
INTRO_CMD_HELP: Not affected are: \n
- The state set with the command [:SOURce<hw>]:IQ:OUTPut:ANALog:STATe.
- If SCONfiguration:EXTernal:PBEHaviour 1, the I/Q ouptput type set with the command [:SOURce<hw>]:IQ:OUTPut[:ANALog]:TYPE. \n
Same as preset, but waits for the operation to complete before continuing further. Use the RsSmw.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:PRESet', opc_timeout_ms)
# noinspection PyTypeChecker
[docs]
def get_type_py(self) -> enums.IqOutType:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:TYPE \n
Snippet: value: enums.IqOutType = driver.source.iq.output.analog.get_type_py() \n
Sets the type of the analog signal. \n
:return: type_py: No help available
"""
response = self._core.io.query_str('SOURce<HwInstance>:IQ:OUTPut:ANALog:TYPE?')
return Conversions.str_to_scalar_enum(response, enums.IqOutType)
[docs]
def set_type_py(self, type_py: enums.IqOutType) -> None:
"""SCPI: [SOURce<HW>]:IQ:OUTPut:[ANALog]:TYPE \n
Snippet: driver.source.iq.output.analog.set_type_py(type_py = enums.IqOutType.DAC) \n
Sets the type of the analog signal. \n
:param type_py: No help available
"""
param = Conversions.enum_scalar_to_str(type_py, enums.IqOutType)
self._core.io.write(f'SOURce<HwInstance>:IQ:OUTPut:ANALog:TYPE {param}')
def clone(self) -> 'AnalogCls':
"""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 = AnalogCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group