from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
from ....Internal.RepeatedCapability import RepeatedCapability
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]class StateCls:
"""State commands group definition. 1 total commands, 0 Subgroups, 1 group commands
Repeated Capability: Status, default value after init: Status.Nr1"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("state", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_status_get', 'repcap_status_set', repcap.Status.Nr1)
def repcap_status_set(self, status: repcap.Status) -> None:
"""Repeated Capability default value numeric suffix.
This value is used, if you do not explicitely set it in the child set/get methods, or if you leave it to Status.Default
Default value after init: Status.Nr1"""
self._cmd_group.set_repcap_enum_value(status)
def repcap_status_get(self) -> repcap.Status:
"""Returns the current default repeated capability for the child set/get methods"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
[docs] def set(self, average_mode: bool, status=repcap.Status.Default) -> None:
"""SCPI: [SENSe]:AVERage:STATe<t> \n
Snippet: driver.sense.average.state.set(average_mode = False, status = repcap.Status.Default) \n
This command turns averaging of the I/Q data on and off. Before you can use the command you have to turn the I/Q data
acquisition on with method RsFsw.Applications.IqAnalyzer.Trace.Iq.State.set. If averaging is on, the maximum amount of
I/Q data that can be recorded is 512kS (524288 samples) . \n
:param average_mode: ON | OFF | 0 | 1 OFF | 0 Switches the function off ON | 1 Switches the function on
:param status: optional repeated capability selector. Default value: Nr1 (settable in the interface 'State')
"""
param = Conversions.bool_to_str(average_mode)
status_cmd_val = self._cmd_group.get_repcap_cmd_value(status, repcap.Status)
self._core.io.write(f'SENSe:AVERage:STATe{status_cmd_val} {param}')
[docs] def get(self, status=repcap.Status.Default) -> bool:
"""SCPI: [SENSe]:AVERage:STATe<t> \n
Snippet: value: bool = driver.sense.average.state.get(status = repcap.Status.Default) \n
This command turns averaging of the I/Q data on and off. Before you can use the command you have to turn the I/Q data
acquisition on with method RsFsw.Applications.IqAnalyzer.Trace.Iq.State.set. If averaging is on, the maximum amount of
I/Q data that can be recorded is 512kS (524288 samples) . \n
:param status: optional repeated capability selector. Default value: Nr1 (settable in the interface 'State')
:return: average_mode: No help available"""
status_cmd_val = self._cmd_group.get_repcap_cmd_value(status, repcap.Status)
response = self._core.io.query_str(f'SENSe:AVERage:STATe{status_cmd_val}?')
return Conversions.str_to_bool(response)
def clone(self) -> 'StateCls':
"""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 = StateCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group