from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
from ...... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class IqRecorderCls:
"""IqRecorder commands group definition. 9 total commands, 1 Subgroups, 8 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("iqRecorder", core, parent)
@property
def catalog(self):
"""catalog commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_catalog'):
from .Catalog import CatalogCls
self._catalog = CatalogCls(self._core, self._cmd_group)
return self._catalog
[docs]
def get_offset(self) -> int:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:OFFSet \n
Snippet: value: int = driver.trigger.gprf.measurement.iqRecorder.get_offset() \n
Defines a delay time for triggered measurements. The trigger offset delays the start of the measurement relative to the
trigger event. \n
:return: trigger_offset: Trigger offset in samples.
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:OFFSet?')
return Conversions.str_to_int(response)
[docs]
def set_offset(self, trigger_offset: int) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:OFFSet \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_offset(trigger_offset = 1) \n
Defines a delay time for triggered measurements. The trigger offset delays the start of the measurement relative to the
trigger event. \n
:param trigger_offset: Trigger offset in samples.
"""
param = Conversions.decimal_value_to_str(trigger_offset)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:OFFSet {param}')
[docs]
def get_mgap(self) -> float:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:MGAP \n
Snippet: value: float = driver.trigger.gprf.measurement.iqRecorder.get_mgap() \n
Sets a minimum time during which the IF signal must be below the trigger threshold before the trigger is armed so that an
IF power trigger event can be generated. The I/Q recorder always runs in single-shot mode. Therefore it is controlled by
a single trigger event. The minimum trigger gap condition is valid between the start of the measurement and the first
trigger event. \n
:return: minimum_gap: No help available
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:MGAP?')
return Conversions.str_to_float(response)
[docs]
def set_mgap(self, minimum_gap: float) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:MGAP \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_mgap(minimum_gap = 1.0) \n
Sets a minimum time during which the IF signal must be below the trigger threshold before the trigger is armed so that an
IF power trigger event can be generated. The I/Q recorder always runs in single-shot mode. Therefore it is controlled by
a single trigger event. The minimum trigger gap condition is valid between the start of the measurement and the first
trigger event. \n
:param minimum_gap: No help available
"""
param = Conversions.decimal_value_to_str(minimum_gap)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:MGAP {param}')
[docs]
def get_timeout(self) -> float or bool:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:TOUT \n
Snippet: value: float or bool = driver.trigger.gprf.measurement.iqRecorder.get_timeout() \n
Selects the maximum time that the measurement waits for a trigger event before it stops in remote control mode or
indicates a trigger timeout in manual operation mode. This setting has no influence on Free Run measurements. \n
:return: timeout: (float or boolean) No help available
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:TOUT?')
return Conversions.str_to_float_or_bool(response)
[docs]
def set_timeout(self, timeout: float or bool) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:TOUT \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_timeout(timeout = 1.0) \n
Selects the maximum time that the measurement waits for a trigger event before it stops in remote control mode or
indicates a trigger timeout in manual operation mode. This setting has no influence on Free Run measurements. \n
:param timeout: (float or boolean) No help available
"""
param = Conversions.decimal_or_bool_value_to_str(timeout)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:TOUT {param}')
[docs]
def get_threshold(self) -> float:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:THReshold \n
Snippet: value: float = driver.trigger.gprf.measurement.iqRecorder.get_threshold() \n
Defines the trigger threshold for power trigger sources. Signals below the threshold are not evaluated for the phase
change trigger source. \n
:return: threshold: No help available
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:THReshold?')
return Conversions.str_to_float(response)
[docs]
def set_threshold(self, threshold: float) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:THReshold \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_threshold(threshold = 1.0) \n
Defines the trigger threshold for power trigger sources. Signals below the threshold are not evaluated for the phase
change trigger source. \n
:param threshold: No help available
"""
param = Conversions.decimal_value_to_str(threshold)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:THReshold {param}')
[docs]
def get_pc_threshold(self) -> float:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTHreshold \n
Snippet: value: float = driver.trigger.gprf.measurement.iqRecorder.get_pc_threshold() \n
Defines the minimum absolute phase change required to generate a trigger event for the phase change trigger source. \n
:return: phase_chg_thres: No help available
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTHreshold?')
return Conversions.str_to_float(response)
[docs]
def set_pc_threshold(self, phase_chg_thres: float) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTHreshold \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_pc_threshold(phase_chg_thres = 1.0) \n
Defines the minimum absolute phase change required to generate a trigger event for the phase change trigger source. \n
:param phase_chg_thres: No help available
"""
param = Conversions.decimal_value_to_str(phase_chg_thres)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTHreshold {param}')
[docs]
def get_pc_time(self) -> float or bool:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTime \n
Snippet: value: float or bool = driver.trigger.gprf.measurement.iqRecorder.get_pc_time() \n
Defines the time interval during which a phase change must occur to generate a trigger event for the phase change trigger
source. \n
:return: phase_chg_time: (float or boolean) No help available
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTime?')
return Conversions.str_to_float_or_bool(response)
[docs]
def set_pc_time(self, phase_chg_time: float or bool) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTime \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_pc_time(phase_chg_time = 1.0) \n
Defines the time interval during which a phase change must occur to generate a trigger event for the phase change trigger
source. \n
:param phase_chg_time: (float or boolean) No help available
"""
param = Conversions.decimal_or_bool_value_to_str(phase_chg_time)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:PCTime {param}')
# noinspection PyTypeChecker
[docs]
def get_slope(self) -> enums.SignalSlopeExt:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SLOPe \n
Snippet: value: enums.SignalSlopeExt = driver.trigger.gprf.measurement.iqRecorder.get_slope() \n
Qualifies whether the trigger event is generated at the rising or at the falling edge of the trigger pulse (valid for
external and power trigger sources) . \n
:return: event: REDGe: rising edge FEDGe: falling edge
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SLOPe?')
return Conversions.str_to_scalar_enum(response, enums.SignalSlopeExt)
[docs]
def set_slope(self, event: enums.SignalSlopeExt) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SLOPe \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_slope(event = enums.SignalSlopeExt.FALLing) \n
Qualifies whether the trigger event is generated at the rising or at the falling edge of the trigger pulse (valid for
external and power trigger sources) . \n
:param event: REDGe: rising edge FEDGe: falling edge
"""
param = Conversions.enum_scalar_to_str(event, enums.SignalSlopeExt)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SLOPe {param}')
[docs]
def get_source(self) -> str:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SOURce \n
Snippet: value: str = driver.trigger.gprf.measurement.iqRecorder.get_source() \n
Selects the source of the trigger events. Some values are always available. They are listed below. Depending on the
installed options, additional values are available. You can query a list of all supported values via TRIGger:...
:CATalog:SOURce?. \n
:return: trigger: No help available
"""
response = self._core.io.query_str('TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SOURce?')
return trim_str_response(response)
[docs]
def set_source(self, trigger: str) -> None:
"""SCPI: TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SOURce \n
Snippet: driver.trigger.gprf.measurement.iqRecorder.set_source(trigger = 'abc') \n
Selects the source of the trigger events. Some values are always available. They are listed below. Depending on the
installed options, additional values are available. You can query a list of all supported values via TRIGger:...
:CATalog:SOURce?. \n
:param trigger: 'IF Power': IF power trigger 'Free Run': free run (untriggered) 'Phase Change': phase change trigger
"""
param = Conversions.value_to_quoted_str(trigger)
self._core.io.write(f'TRIGger:GPRF:MEASurement<Instance>:IQRecorder:SOURce {param}')
def clone(self) -> 'IqRecorderCls':
"""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 = IqRecorderCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group