from ...Internal.Core import Core
from ...Internal.CommandsGroup import CommandsGroup
from ...Internal import Conversions
from ...Internal.Utilities import trim_str_response
from ... import enums
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class ReceiverCls:
"""Receiver commands group definition. 24 total commands, 1 Subgroups, 7 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("receiver", core, parent)
@property
def antenna(self):
"""antenna commands group. 3 Sub-classes, 8 commands."""
if not hasattr(self, '_antenna'):
from .Antenna import AntennaCls
self._antenna = AntennaCls(self._core, self._cmd_group)
return self._antenna
[docs]
def get_catalog(self) -> str:
"""SCPI: RECeiver:CATalog \n
Snippet: value: str = driver.receiver.get_catalog() \n
Queries the available repository elements in the database. \n
:return: catalog: string
"""
response = self._core.io.query_str('RECeiver:CATalog?')
return trim_str_response(response)
[docs]
def set_create(self, create: str) -> None:
"""SCPI: RECeiver:CREate \n
Snippet: driver.receiver.set_create(create = 'abc') \n
Creates a repository element with the selected name. \n
:param create: string Must be unique for the particular type of repository elements. May contain empty spaces.
"""
param = Conversions.value_to_quoted_str(create)
self._core.io.write(f'RECeiver:CREate {param}')
# noinspection PyTypeChecker
[docs]
def get_model(self) -> enums.RecModel:
"""SCPI: RECeiver:MODel \n
Snippet: value: enums.RecModel = driver.receiver.get_model() \n
Sets the receiver model. \n
:return: model: INTerfero| TDOA| COMBined For details, see 'Model'. INTerfero Interferometer Calculates the relative phase difference between the single antenna ports. TDOA Time difference of arrival Calculates the absolute time of arrival (TOA) of the incoming signal for each antenna. COMBined Calculates the relative phases between the antenna ports and calculates the the individual TOAs for each antenna port.
"""
response = self._core.io.query_str('RECeiver:MODel?')
return Conversions.str_to_scalar_enum(response, enums.RecModel)
[docs]
def set_model(self, model: enums.RecModel) -> None:
"""SCPI: RECeiver:MODel \n
Snippet: driver.receiver.set_model(model = enums.RecModel.COMBined) \n
Sets the receiver model. \n
:param model: INTerfero| TDOA| COMBined For details, see 'Model'. INTerfero Interferometer Calculates the relative phase difference between the single antenna ports. TDOA Time difference of arrival Calculates the absolute time of arrival (TOA) of the incoming signal for each antenna. COMBined Calculates the relative phases between the antenna ports and calculates the the individual TOAs for each antenna port.
"""
param = Conversions.enum_scalar_to_str(model, enums.RecModel)
self._core.io.write(f'RECeiver:MODel {param}')
[docs]
def get_name(self) -> str:
"""SCPI: RECeiver:NAME \n
Snippet: value: str = driver.receiver.get_name() \n
Renames the selected repository element. \n
:return: name: string Must be unique for the particular type of repository elements. May contain empty spaces.
"""
response = self._core.io.query_str('RECeiver:NAME?')
return trim_str_response(response)
[docs]
def set_name(self, name: str) -> None:
"""SCPI: RECeiver:NAME \n
Snippet: driver.receiver.set_name(name = 'abc') \n
Renames the selected repository element. \n
:param name: string Must be unique for the particular type of repository elements. May contain empty spaces.
"""
param = Conversions.value_to_quoted_str(name)
self._core.io.write(f'RECeiver:NAME {param}')
[docs]
def set_remove(self, remove: str) -> None:
"""SCPI: RECeiver:REMove \n
Snippet: driver.receiver.set_remove(remove = 'abc') \n
Removes the selected element from the workspace. The element must not reference any child elements. Remove the referenced
elements first. \n
:param remove: No help available
"""
param = Conversions.value_to_quoted_str(remove)
self._core.io.write(f'RECeiver:REMove {param}')
[docs]
def get_select(self) -> str:
"""SCPI: RECeiver:SELect \n
Snippet: value: str = driver.receiver.get_select() \n
Selects the repository element to which the subsequent commands apply. \n
:return: select: string Element name, as defined with the ...:CREate or ...:NAME command. To query the existing elements, use the ...:CATalog? command. For example, method RsPulseSeq.Repository.catalog.
"""
response = self._core.io.query_str('RECeiver:SELect?')
return trim_str_response(response)
[docs]
def set_select(self, select: str) -> None:
"""SCPI: RECeiver:SELect \n
Snippet: driver.receiver.set_select(select = 'abc') \n
Selects the repository element to which the subsequent commands apply. \n
:param select: string Element name, as defined with the ...:CREate or ...:NAME command. To query the existing elements, use the ...:CATalog? command. For example, method RsPulseSeq.Repository.catalog.
"""
param = Conversions.value_to_quoted_str(select)
self._core.io.write(f'RECeiver:SELect {param}')
def clone(self) -> 'ReceiverCls':
"""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 = ReceiverCls(self._core, self._cmd_group.parent)
self._cmd_group.synchronize_repcaps(new_group)
return new_group