from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal.RepeatedCapability import RepeatedCapability
from .... import repcap
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
class RefCurveCls:
"""
| Commands in total: 12
| Subgroups: 10
| Direct child commands: 2
Repeated Capability Setting:
.. code-block:: python
# Range: Nr1 .. Nr8 \n
driver.franalysis.refCurve.repcap_refCurve_set(repcap.RefCurve.Nr1)
"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("refCurve", core, parent)
self._cmd_group.rep_cap = RepeatedCapability(self._cmd_group.group_name, 'repcap_refCurve_get', 'repcap_refCurve_set', repcap.RefCurve.Nr1)
def repcap_refCurve_set(self, refCurve: repcap.RefCurve) -> 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 RefCurve.Default.
Default value after init: RefCurve.Nr1
"""
self._cmd_group.set_repcap_enum_value(refCurve)
def repcap_refCurve_get(self) -> repcap.RefCurve:
"""
Returns the current default repeated capability for the child set/get methods.
"""
# noinspection PyTypeChecker
return self._cmd_group.get_repcap_enum_value()
@property
def enable(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_enable'):
from .Enable import EnableCls
self._enable = EnableCls(self._core, self._cmd_group)
return self._enable
@property
def source(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_source'):
from .Source import SourceCls
self._source = SourceCls(self._core, self._cmd_group)
return self._source
@property
def scale(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_scale'):
from .Scale import ScaleCls
self._scale = ScaleCls(self._core, self._cmd_group)
return self._scale
@property
def offset(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_offset'):
from .Offset import OffsetCls
self._offset = OffsetCls(self._core, self._cmd_group)
return self._offset
@property
def vmode(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_vmode'):
from .Vmode import VmodeCls
self._vmode = VmodeCls(self._core, self._cmd_group)
return self._vmode
@property
def name(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_name'):
from .Name import NameCls
self._name = NameCls(self._core, self._cmd_group)
return self._name
@property
def update(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_update'):
from .Update import UpdateCls
self._update = UpdateCls(self._core, self._cmd_group)
return self._update
@property
def open(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_open'):
from .Open import OpenCls
self._open = OpenCls(self._core, self._cmd_group)
return self._open
@property
def toOriginal(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_toOriginal'):
from .ToOriginal import ToOriginalCls
self._toOriginal = ToOriginalCls(self._core, self._cmd_group)
return self._toOriginal
@property
def data(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_data'):
from .Data import DataCls
self._data = DataCls(self._core, self._cmd_group)
return self._data
[docs]
def clear(self, refCurve=repcap.RefCurve.Default) -> None:
"""
``FRANalysis:REFCurve<*>:CLEar`` \n
Snippet: ``driver.franalysis.refCurve.clear(refCurve = repcap.RefCurve.Default)`` \n
Deletes the selected reference waveform. It disappears from the display, and its memory is deleted.
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
"""
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
self._core.io.write(f'FRANalysis:REFCurve{refCurve_cmd_val}:CLEar')
[docs]
def clear_and_wait(self, refCurve=repcap.RefCurve.Default, opc_timeout_ms: int = -1) -> None:
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
"""
``FRANalysis:REFCurve<*>:CLEar`` \n
Snippet: ``driver.franalysis.refCurve.clear_and_wait(refCurve = repcap.RefCurve.Default)`` \n
Deletes the selected reference waveform. It disappears from the display, and its memory is deleted.
Same as clear, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value.
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'FRANalysis:REFCurve{refCurve_cmd_val}:CLEar', opc_timeout_ms)
[docs]
def save(self, refCurve=repcap.RefCurve.Default) -> None:
"""
``FRANalysis:REFCurve<*>:SAVE`` \n
Snippet: ``driver.franalysis.refCurve.save(refCurve = repcap.RefCurve.Default)`` \n
Saves the FRA reference waveform to the file defined by method ``RsMxo.franalysis.refCurve.name.set()`` .
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
"""
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
self._core.io.write(f'FRANalysis:REFCurve{refCurve_cmd_val}:SAVE')
[docs]
def save_and_wait(self, refCurve=repcap.RefCurve.Default, opc_timeout_ms: int = -1) -> None:
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
"""
``FRANalysis:REFCurve<*>:SAVE`` \n
Snippet: ``driver.franalysis.refCurve.save_and_wait(refCurve = repcap.RefCurve.Default)`` \n
Saves the FRA reference waveform to the file defined by method ``RsMxo.franalysis.refCurve.name.set()`` .
Same as save, but waits for the operation to complete before continuing further. Use the RsMxo.utilities.opc_timeout_set() to set the timeout value.
:param refCurve: optional repeated capability selector. Default value: Nr1 (settable in the interface 'RefCurve')
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call.
"""
self._core.io.write_with_opc(f'FRANalysis:REFCurve{refCurve_cmd_val}:SAVE', opc_timeout_ms)
def clone(self) -> 'RefCurveCls':
"""
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 = RefCurveCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group