from ......Internal.Core import Core
from ......Internal.CommandsGroup import CommandsGroup
from ......Internal import Conversions
from ......Internal.Utilities import trim_str_response
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class EmitterCls:
"""Emitter commands group definition. 5 total commands, 1 Subgroups, 4 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("emitter", core, parent)
@property
def add(self):
"""add commands group. 0 Sub-classes, 1 commands."""
if not hasattr(self, '_add'):
from .Add import AddCls
self._add = AddCls(self._core, self._cmd_group)
return self._add
[docs]
def clear(self) -> None:
"""SCPI: ASSignment:DESTination:PATH:EMITter:CLEar \n
Snippet: driver.assignment.destination.path.emitter.clear() \n
Deletes all items from the list or the table. \n
"""
self._core.io.write(f'ASSignment:DESTination:PATH:EMITter:CLEar')
[docs]
def clear_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: ASSignment:DESTination:PATH:EMITter:CLEar \n
Snippet: driver.assignment.destination.path.emitter.clear_with_opc() \n
Deletes all items from the list or the table. \n
Same as clear, but waits for the operation to complete before continuing further. Use the RsPulseSeq.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'ASSignment:DESTination:PATH:EMITter:CLEar', opc_timeout_ms)
[docs]
def delete(self) -> None:
"""SCPI: ASSignment:DESTination:PATH:EMITter:DELete \n
Snippet: driver.assignment.destination.path.emitter.delete() \n
Deletes the particular item. \n
"""
self._core.io.write(f'ASSignment:DESTination:PATH:EMITter:DELete')
[docs]
def delete_with_opc(self, opc_timeout_ms: int = -1) -> None:
"""SCPI: ASSignment:DESTination:PATH:EMITter:DELete \n
Snippet: driver.assignment.destination.path.emitter.delete_with_opc() \n
Deletes the particular item. \n
Same as delete, but waits for the operation to complete before continuing further. Use the RsPulseSeq.utilities.opc_timeout_set() to set the timeout value. \n
:param opc_timeout_ms: Maximum time to wait in milliseconds, valid only for this call."""
self._core.io.write_with_opc(f'ASSignment:DESTination:PATH:EMITter:DELete', opc_timeout_ms)
[docs]
def get_list_py(self) -> str:
"""SCPI: ASSignment:DESTination:PATH:EMITter:LIST \n
Snippet: value: str = driver.assignment.destination.path.emitter.get_list_py() \n
Queries the list of assigned emitters to the selected path. \n
:return: list_py: 'Emitter/Inter#1','Emitter/Inter#2',...
"""
response = self._core.io.query_str('ASSignment:DESTination:PATH:EMITter:LIST?')
return trim_str_response(response)
[docs]
def get_select(self) -> str:
"""SCPI: ASSignment:DESTination:PATH:EMITter:SELect \n
Snippet: value: str = driver.assignment.destination.path.emitter.get_select() \n
Selects the element to which the subsequent commands apply. \n
:return: select: string Available element as queried with the corresponding ...:LIST command. For example, method RsPulseSeq.Assignment.Destination.Path.Antenna.listPy
"""
response = self._core.io.query_str('ASSignment:DESTination:PATH:EMITter:SELect?')
return trim_str_response(response)
[docs]
def set_select(self, select: str) -> None:
"""SCPI: ASSignment:DESTination:PATH:EMITter:SELect \n
Snippet: driver.assignment.destination.path.emitter.set_select(select = 'abc') \n
Selects the element to which the subsequent commands apply. \n
:param select: string Available element as queried with the corresponding ...:LIST command. For example, method RsPulseSeq.Assignment.Destination.Path.Antenna.listPy
"""
param = Conversions.value_to_quoted_str(select)
self._core.io.write(f'ASSignment:DESTination:PATH:EMITter:SELect {param}')
def clone(self) -> 'EmitterCls':
"""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 = EmitterCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group