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: 33
| Subgroups: 15
| Direct child commands: 4
Repeated Capability Setting:
.. code-block:: python
# Range: Nr1 .. Nr4 \n
driver.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 hmode(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_hmode'):
from .Hmode import HmodeCls
self._hmode = HmodeCls(self._core, self._cmd_group)
return self._hmode
@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 position(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_position'):
from .Position import PositionCls
self._position = PositionCls(self._core, self._cmd_group)
return self._position
@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 restore(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_restore'):
from .Restore import RestoreCls
self._restore = RestoreCls(self._core, self._cmd_group)
return self._restore
@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 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 state(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_state'):
from .State import StateCls
self._state = StateCls(self._core, self._cmd_group)
return self._state
@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 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 toOrignal(self):
"""
| Commands in total: 1
| Subgroups: 0
| Direct child commands: 1
"""
if not hasattr(self, '_toOrignal'):
from .ToOrignal import ToOrignalCls
self._toOrignal = ToOrignalCls(self._core, self._cmd_group)
return self._toOrignal
@property
def data(self):
"""
| Commands in total: 3
| Subgroups: 3
| Direct child commands: 0
"""
if not hasattr(self, '_data'):
from .Data import DataCls
self._data = DataCls(self._core, self._cmd_group)
return self._data
@property
def rescale(self):
"""
| Commands in total: 6
| Subgroups: 2
| Direct child commands: 0
"""
if not hasattr(self, '_rescale'):
from .Rescale import RescaleCls
self._rescale = RescaleCls(self._core, self._cmd_group)
return self._rescale
@property
def multiChannel(self):
"""
| Commands in total: 3
| Subgroups: 2
| Direct child commands: 1
"""
if not hasattr(self, '_multiChannel'):
from .MultiChannel import MultiChannelCls
self._multiChannel = MultiChannelCls(self._core, self._cmd_group)
return self._multiChannel
@property
def cdr(self):
"""
| Commands in total: 6
| Subgroups: 6
| Direct child commands: 0
"""
if not hasattr(self, '_cdr'):
from .Cdr import CdrCls
self._cdr = CdrCls(self._core, self._cmd_group)
return self._cdr
[docs]
def clear(self, refCurve=repcap.RefCurve.Default, opc_timeout_ms: int = -1) -> None:
"""
``REFCurve<*>:CLEar`` \n
Snippet: ``driver.refCurve.clear(refCurve = repcap.RefCurve.Default)`` \n
The selected reference waveform is no longer displayed, its memory is deleted.
: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.
"""
refCurve_cmd_val = self._cmd_group.get_repcap_cmd_value(refCurve, repcap.RefCurve)
self._core.io.write_with_opc(f'REFCurve{refCurve_cmd_val}:CLEar', opc_timeout_ms)
[docs]
def delete(self, refCurve=repcap.RefCurve.Default) -> None:
"""
``REFCurve<*>:DELete`` \n
Snippet: ``driver.refCurve.delete(refCurve = repcap.RefCurve.Default)`` \n
Deletes the reference waveform file selected by method ``RsRtx.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'REFCurve{refCurve_cmd_val}:DELete')
[docs]
def delete_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)
"""
``REFCurve<*>:DELete`` \n
Snippet: ``driver.refCurve.delete_and_wait(refCurve = repcap.RefCurve.Default)`` \n
Deletes the reference waveform file selected by method ``RsRtx.refCurve.name.set()`` .
Same as delete, but waits for the operation to complete before continuing further. Use the RsRtx.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'REFCurve{refCurve_cmd_val}:DELete', opc_timeout_ms)
[docs]
def open(self, refCurve=repcap.RefCurve.Default) -> None:
"""
``REFCurve<*>:OPEN`` \n
Snippet: ``driver.refCurve.open(refCurve = repcap.RefCurve.Default)`` \n
Loads the reference waveform file selected by method ``RsRtx.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'REFCurve{refCurve_cmd_val}:OPEN')
[docs]
def open_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)
"""
``REFCurve<*>:OPEN`` \n
Snippet: ``driver.refCurve.open_and_wait(refCurve = repcap.RefCurve.Default)`` \n
Loads the reference waveform file selected by method ``RsRtx.refCurve.name.set()`` .
Same as open, but waits for the operation to complete before continuing further. Use the RsRtx.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'REFCurve{refCurve_cmd_val}:OPEN', opc_timeout_ms)
[docs]
def save(self, refCurve=repcap.RefCurve.Default) -> None:
"""
``REFCurve<*>:SAVE`` \n
Snippet: ``driver.refCurve.save(refCurve = repcap.RefCurve.Default)`` \n
Saves the reference waveform to the file selected by method ``RsRtx.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'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)
"""
``REFCurve<*>:SAVE`` \n
Snippet: ``driver.refCurve.save_and_wait(refCurve = repcap.RefCurve.Default)`` \n
Saves the reference waveform to the file selected by method ``RsRtx.refCurve.name.set()`` .
Same as save, but waits for the operation to complete before continuing further. Use the RsRtx.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'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