from .......Internal.Core import Core
from .......Internal.CommandsGroup import CommandsGroup
from .......Internal import Conversions
from .......Internal.StructBase import StructBase
from .......Internal.ArgStruct import ArgStruct
from ....... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class ListPyCls:
"""ListPy commands group definition. 27 total commands, 9 Subgroups, 10 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("listPy", core, parent)
@property
def iqData(self):
"""iqData commands group. 0 Sub-classes, 3 commands."""
if not hasattr(self, '_iqData'):
from .IqData import IqDataCls
self._iqData = IqDataCls(self._core, self._cmd_group)
return self._iqData
@property
def sstop(self):
"""sstop commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_sstop'):
from .Sstop import SstopCls
self._sstop = SstopCls(self._core, self._cmd_group)
return self._sstop
@property
def frequency(self):
"""frequency commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_frequency'):
from .Frequency import FrequencyCls
self._frequency = FrequencyCls(self._core, self._cmd_group)
return self._frequency
@property
def envelopePower(self):
"""envelopePower commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_envelopePower'):
from .EnvelopePower import EnvelopePowerCls
self._envelopePower = EnvelopePowerCls(self._core, self._cmd_group)
return self._envelopePower
@property
def retrigger(self):
"""retrigger commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_retrigger'):
from .Retrigger import RetriggerCls
self._retrigger = RetriggerCls(self._core, self._cmd_group)
return self._retrigger
@property
def irepetition(self):
"""irepetition commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_irepetition'):
from .Irepetition import IrepetitionCls
self._irepetition = IrepetitionCls(self._core, self._cmd_group)
return self._irepetition
@property
def parameterSetList(self):
"""parameterSetList commands group. 0 Sub-classes, 2 commands."""
if not hasattr(self, '_parameterSetList'):
from .ParameterSetList import ParameterSetListCls
self._parameterSetList = ParameterSetListCls(self._core, self._cmd_group)
return self._parameterSetList
@property
def idx(self):
"""idx commands group. 2 Sub-classes, 0 commands."""
if not hasattr(self, '_idx'):
from .Idx import IdxCls
self._idx = IdxCls(self._core, self._cmd_group)
return self._idx
@property
def cidx(self):
"""cidx commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_cidx'):
from .Cidx import CidxCls
self._cidx = CidxCls(self._core, self._cmd_group)
return self._cidx
# noinspection PyTypeChecker
[docs]
def get_txi_mode(self) -> enums.TxiMode:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXIMode \n
Snippet: value: enums.TxiMode = driver.configure.gprf.measurement.power.listPy.get_txi_mode() \n
Selects the repetition of the GPRF Meas<i>:Power trigger signal, generated by the power measurement for a repeated
segment. \n
:return: mode:
- IREPetition: Index repetition - trigger signal after each repetition of the segment.
- LENTry: List entry - trigger signal only after the last repetition of the segment."""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXIMode?')
return Conversions.str_to_scalar_enum(response, enums.TxiMode)
[docs]
def set_txi_mode(self, mode: enums.TxiMode) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXIMode \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_txi_mode(mode = enums.TxiMode.IREPetition) \n
Selects the repetition of the GPRF Meas<i>:Power trigger signal, generated by the power measurement for a repeated
segment. \n
:param mode:
- IREPetition: Index repetition - trigger signal after each repetition of the segment.
- LENTry: List entry - trigger signal only after the last repetition of the segment."""
param = Conversions.enum_scalar_to_str(mode, enums.TxiMode)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXIMode {param}')
# noinspection PyTypeChecker
[docs]
def get_txi_timing(self) -> enums.Timing:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXITiming \n
Snippet: value: enums.Timing = driver.configure.gprf.measurement.power.listPy.get_txi_timing() \n
Specifies the timing of the generated GPRF Meas<i>:Power trigger. \n
:return: timing: STEP: Trigger signals are generated between step lengths. CENTered: Trigger signals are generated between measurement lengths.
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXITiming?')
return Conversions.str_to_scalar_enum(response, enums.Timing)
[docs]
def set_txi_timing(self, timing: enums.Timing) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXITiming \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_txi_timing(timing = enums.Timing.CENTered) \n
Specifies the timing of the generated GPRF Meas<i>:Power trigger. \n
:param timing: STEP: Trigger signals are generated between step lengths. CENTered: Trigger signals are generated between measurement lengths.
"""
param = Conversions.enum_scalar_to_str(timing, enums.Timing)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:TXITiming {param}')
# noinspection PyTypeChecker
[docs]
class FillStruct(StructBase): # From WriteStructDefinition CmdPropertyTemplate.xml
"""Structure for setting input parameters. Contains optional set arguments. Fields: \n
- Start_Index: float: No parameter help available
- Range_Py: float: No parameter help available
- Index_Repetition: float: No parameter help available
- Start_Frequency: float: No parameter help available
- Freq_Increment: float: No parameter help available
- Start_Power: float: No parameter help available
- Power_Increment: float: No parameter help available
- Retrigger: bool: No parameter help available
- Iq_Data: bool: No parameter help available
- Parameter_Set: int: No parameter help available"""
__meta_args_list = [
ArgStruct.scalar_float('Start_Index'),
ArgStruct.scalar_float('Range_Py'),
ArgStruct.scalar_float('Index_Repetition'),
ArgStruct.scalar_float('Start_Frequency'),
ArgStruct.scalar_float('Freq_Increment'),
ArgStruct.scalar_float('Start_Power'),
ArgStruct.scalar_float('Power_Increment'),
ArgStruct.scalar_bool_optional('Retrigger'),
ArgStruct.scalar_bool_optional('Iq_Data'),
ArgStruct.scalar_int_optional('Parameter_Set')]
def __init__(self):
StructBase.__init__(self, self)
self.Start_Index: float = None
self.Range_Py: float = None
self.Index_Repetition: float = None
self.Start_Frequency: float = None
self.Freq_Increment: float = None
self.Start_Power: float = None
self.Power_Increment: float = None
self.Retrigger: bool = None
self.Iq_Data: bool = None
self.Parameter_Set: int = None
[docs]
def set_fill(self, value: FillStruct) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:FILL \n
Snippet with structure: \n
structure = driver.configure.gprf.measurement.power.listPy.FillStruct() \n
structure.Start_Index: float = 1.0 \n
structure.Range_Py: float = 1.0 \n
structure.Index_Repetition: float = 1.0 \n
structure.Start_Frequency: float = 1.0 \n
structure.Freq_Increment: float = 1.0 \n
structure.Start_Power: float = 1.0 \n
structure.Power_Increment: float = 1.0 \n
structure.Retrigger: bool = False \n
structure.Iq_Data: bool = False \n
structure.Parameter_Set: int = 1 \n
driver.configure.gprf.measurement.power.listPy.set_fill(value = structure) \n
No command help available \n
:param value: see the help for FillStruct structure arguments.
"""
self._core.io.write_struct('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:FILL', value)
# noinspection PyTypeChecker
[docs]
def get_munit(self) -> enums.MagnitudeUnit:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:MUNit \n
Snippet: value: enums.MagnitudeUnit = driver.configure.gprf.measurement.power.listPy.get_munit() \n
No command help available \n
:return: magnitude_unit: No help available
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:MUNit?')
return Conversions.str_to_scalar_enum(response, enums.MagnitudeUnit)
[docs]
def set_munit(self, magnitude_unit: enums.MagnitudeUnit) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:MUNit \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_munit(magnitude_unit = enums.MagnitudeUnit.RAW) \n
No command help available \n
:param magnitude_unit: No help available
"""
param = Conversions.enum_scalar_to_str(magnitude_unit, enums.MagnitudeUnit)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:MUNit {param}')
[docs]
def get_count(self) -> int:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:COUNt \n
Snippet: value: int = driver.configure.gprf.measurement.power.listPy.get_count() \n
Queries the total number of segments per sweep, including repetitions. \n
:return: result_count: No help available
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:COUNt?')
return Conversions.str_to_int(response)
[docs]
def get_start(self) -> int:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STARt \n
Snippet: value: int = driver.configure.gprf.measurement.power.listPy.get_start() \n
Selects the first segment to be measured (start of a sweep) . The total number of segments per sweep, including
repetitions, must not be higher than 10000. \n
:return: start_index: No help available
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STARt?')
return Conversions.str_to_int(response)
[docs]
def set_start(self, start_index: int) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STARt \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_start(start_index = 1) \n
Selects the first segment to be measured (start of a sweep) . The total number of segments per sweep, including
repetitions, must not be higher than 10000. \n
:param start_index: No help available
"""
param = Conversions.decimal_value_to_str(start_index)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STARt {param}')
[docs]
def get_stop(self) -> int:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STOP \n
Snippet: value: int = driver.configure.gprf.measurement.power.listPy.get_stop() \n
Selects the last segment to be measured (the end of a sweep) . The total number of segments per sweep, including
repetitions, must not be higher than 10000. \n
:return: stop_index: No help available
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STOP?')
return Conversions.str_to_int(response)
[docs]
def set_stop(self, stop_index: int) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STOP \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_stop(stop_index = 1) \n
Selects the last segment to be measured (the end of a sweep) . The total number of segments per sweep, including
repetitions, must not be higher than 10000. \n
:param stop_index: No help available
"""
param = Conversions.decimal_value_to_str(stop_index)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:STOP {param}')
# noinspection PyTypeChecker
[docs]
def get_csource(self) -> enums.ConnectionSource:
"""SCPI: [CONFigure]:GPRF:MEASurement<instance>:POWer:LIST:CSOurce \n
Snippet: value: enums.ConnectionSource = driver.configure.gprf.measurement.power.listPy.get_csource() \n
Selects whether all list mode segments use the same RF connection. \n
:return: connection_source: GLOBal: Use the same RF connection for all segments. INDex: Assign a connection index to each segment.
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:CSOurce?')
return Conversions.str_to_scalar_enum(response, enums.ConnectionSource)
[docs]
def set_csource(self, connection_source: enums.ConnectionSource) -> None:
"""SCPI: [CONFigure]:GPRF:MEASurement<instance>:POWer:LIST:CSOurce \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_csource(connection_source = enums.ConnectionSource.GLOBal) \n
Selects whether all list mode segments use the same RF connection. \n
:param connection_source: GLOBal: Use the same RF connection for all segments. INDex: Assign a connection index to each segment.
"""
param = Conversions.enum_scalar_to_str(connection_source, enums.ConnectionSource)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:CSOurce {param}')
[docs]
def get_nidx(self) -> int:
"""SCPI: [CONFigure]:GPRF:MEASurement<instance>:POWer:LIST:NIDX \n
Snippet: value: int = driver.configure.gprf.measurement.power.listPy.get_nidx() \n
Sets the number of connection indices for the list mode, for the connection source INDex. \n
:return: number_of_indices: No help available
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:NIDX?')
return Conversions.str_to_int(response)
[docs]
def set_nidx(self, number_of_indices: int) -> None:
"""SCPI: [CONFigure]:GPRF:MEASurement<instance>:POWer:LIST:NIDX \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_nidx(number_of_indices = 1) \n
Sets the number of connection indices for the list mode, for the connection source INDex. \n
:param number_of_indices: No help available
"""
param = Conversions.decimal_value_to_str(number_of_indices)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST:NIDX {param}')
[docs]
def get_value(self) -> bool:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST \n
Snippet: value: bool = driver.configure.gprf.measurement.power.listPy.get_value() \n
Enables or disables the list mode for the power measurement. \n
:return: enable_list_mode: OFF: list mode off ON: list mode on
"""
response = self._core.io.query_str('CONFigure:GPRF:MEASurement<Instance>:POWer:LIST?')
return Conversions.str_to_bool(response)
[docs]
def set_value(self, enable_list_mode: bool) -> None:
"""SCPI: CONFigure:GPRF:MEASurement<Instance>:POWer:LIST \n
Snippet: driver.configure.gprf.measurement.power.listPy.set_value(enable_list_mode = False) \n
Enables or disables the list mode for the power measurement. \n
:param enable_list_mode: OFF: list mode off ON: list mode on
"""
param = Conversions.bool_to_str(enable_list_mode)
self._core.io.write(f'CONFigure:GPRF:MEASurement<Instance>:POWer:LIST {param}')
def clone(self) -> 'ListPyCls':
"""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 = ListPyCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group