from ....Internal.Core import Core
from ....Internal.CommandsGroup import CommandsGroup
from ....Internal import Conversions
# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs]
class CardoidCls:
"""Cardoid commands group definition. 2 total commands, 0 Subgroups, 2 group commands"""
def __init__(self, core: Core, parent):
self._core = core
self._cmd_group = CommandsGroup("cardoid", core, parent)
[docs]
def get_exponent(self) -> float:
"""SCPI: ANTenna:MODel:CARDoid:EXPonent \n
Snippet: value: float = driver.antenna.model.cardoid.get_exponent() \n
Use values greater than 1 to narrow the antenna beam. \n
:return: exponent: float Range: 1 to 20
"""
response = self._core.io.query_str('ANTenna:MODel:CARDoid:EXPonent?')
return Conversions.str_to_float(response)
[docs]
def set_exponent(self, exponent: float) -> None:
"""SCPI: ANTenna:MODel:CARDoid:EXPonent \n
Snippet: driver.antenna.model.cardoid.set_exponent(exponent = 1.0) \n
Use values greater than 1 to narrow the antenna beam. \n
:param exponent: float Range: 1 to 20
"""
param = Conversions.decimal_value_to_str(exponent)
self._core.io.write(f'ANTenna:MODel:CARDoid:EXPonent {param}')
[docs]
def get_resolution(self) -> float:
"""SCPI: ANTenna:MODel:CARDoid:RESolution \n
Snippet: value: float = driver.antenna.model.cardoid.get_resolution() \n
Sets a custom resolution for the antenna pattern simulation. \n
:return: resolution: float Range: 0.1 to 1
"""
response = self._core.io.query_str('ANTenna:MODel:CARDoid:RESolution?')
return Conversions.str_to_float(response)
[docs]
def set_resolution(self, resolution: float) -> None:
"""SCPI: ANTenna:MODel:CARDoid:RESolution \n
Snippet: driver.antenna.model.cardoid.set_resolution(resolution = 1.0) \n
Sets a custom resolution for the antenna pattern simulation. \n
:param resolution: float Range: 0.1 to 1
"""
param = Conversions.decimal_value_to_str(resolution)
self._core.io.write(f'ANTenna:MODel:CARDoid:RESolution {param}')