from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal.StructBase import StructBase
from .....Internal.ArgStruct import ArgStruct
from ..... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class SetCls:
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("set", core, parent)
# noinspection PyTypeChecker
[docs]
class SetStruct(StructBase):
"""
Structure for setting input parameters. Fields: \n
- 1 State_Peak: bool: ON | OFF | 0 | 1 Turns peak power evaluation on and off.
- 2 State_Rms: bool: ON | OFF | 0 | 1 Turns peak power evaluation on and off.
- 3 State_Avg: bool: ON | OFF | 0 | 1 Turns peak power evaluation on and off.
- 4 Trigger_Source: enums.TriggerSourceListPower: EXTernal | EXT2 | EXT3 | IMMediate | IFPower | RFPower | VIDeo Selects a trigger source. For more information see 'Configuring triggered and gated measurements'.
- 5 Trigger_Slope: enums.SlopeType: POSitive | NEGative Selects the trigger slop.
- 6 Trigger_Offset: float: Defines the trigger delay. Range: negative measurement time to 30 s, Unit: s
- 7 Gate_Length: float: Defines the gate length for gated measurements. Setting 0 seconds turns gated measurements off. To perform gated measurements, the trigger source must be different from IMMediate. Range: 31.25 ns to 30 s, Unit: s
"""
__meta_args_list = [
ArgStruct.scalar_bool('State_Peak'),
ArgStruct.scalar_bool('State_Rms'),
ArgStruct.scalar_bool('State_Avg'),
ArgStruct.scalar_enum('Trigger_Source', enums.TriggerSourceListPower),
ArgStruct.scalar_enum('Trigger_Slope', enums.SlopeType),
ArgStruct.scalar_float('Trigger_Offset'),
ArgStruct.scalar_float('Gate_Length')]
def __init__(self):
StructBase.__init__(self, self)
self.State_Peak: bool=None
self.State_Rms: bool=None
self.State_Avg: bool=None
self.Trigger_Source: enums.TriggerSourceListPower=None
self.Trigger_Slope: enums.SlopeType=None
self.Trigger_Offset: float=None
self.Gate_Length: float=None
[docs]
def set(self, structure: SetStruct) -> None:
"""
``[SENSe]:LIST:POWer:SET`` \n
Snippet with structure: \n
structure = driver.sense.listPy.power.set.SetStruct() \n
structure.State_Peak: bool = False \n
structure.State_Rms: bool = False \n
structure.State_Avg: bool = False \n
structure.Trigger_Source: enums.TriggerSourceListPower = enums.TriggerSourceListPower.EXT2 \n
structure.Trigger_Slope: enums.SlopeType = enums.SlopeType.NEGative \n
structure.Trigger_Offset: float = 1.0 \n
structure.Gate_Length: float = 1.0 \n
driver.sense.listPy.power.set.set(structure) \n
Defines global List Evaluation parameters. These parameters are valid for every frequency you want to measure. The state
of the first three parameters (<PeakPower>, <RMSPower> and <AVGPower>) define the number of results for each frequency in
the list. Note that you have to set the trigger level after sending this command.
:param structure: for set value, see the help for SetStruct structure arguments.
"""
self._core.io.write_struct(f'SENSe:LIST:POWer:SET', structure)
[docs]
def get(self) -> SetStruct:
"""
``[SENSe]:LIST:POWer:SET`` \n
Snippet: ``value: SetStruct = driver.sense.listPy.power.set.get()`` \n
Defines global List Evaluation parameters. These parameters are valid for every frequency you want to measure. The state
of the first three parameters (<PeakPower>, <RMSPower> and <AVGPower>) define the number of results for each frequency in
the list. Note that you have to set the trigger level after sending this command.
:return: structure: for return value, see the help for SetStruct structure arguments.
"""
return self._core.io.query_struct(f'SENSe:LIST:POWer:SET?', self.__class__.SetStruct())