Source code for RsPulseSeq.Implementations.Antenna.Model.Array.Cosn

from .....Internal.Core import Core
from .....Internal.CommandsGroup import CommandsGroup
from .....Internal import Conversions


# noinspection PyPep8Naming,PyAttributeOutsideInit,SpellCheckingInspection
[docs] class CosnCls: """Cosn commands group definition. 3 total commands, 0 Subgroups, 3 group commands""" def __init__(self, core: Core, parent): self._core = core self._cmd_group = CommandsGroup("cosn", core, parent)
[docs] def get_x(self) -> float: """SCPI: ANTenna:MODel:ARRay:COSN:X \n Snippet: value: float = driver.antenna.model.array.cosn.get_x() \n Requires ANTenna:MODel:ARRay:DISTribution:TYPE 1. Sets the individual value of the coefficient N in the cosN distribution for X and Z direction. \n :return: x: float Range: 2 to 10 """ response = self._core.io.query_str('ANTenna:MODel:ARRay:COSN:X?') return Conversions.str_to_float(response)
[docs] def set_x(self, x: float) -> None: """SCPI: ANTenna:MODel:ARRay:COSN:X \n Snippet: driver.antenna.model.array.cosn.set_x(x = 1.0) \n Requires ANTenna:MODel:ARRay:DISTribution:TYPE 1. Sets the individual value of the coefficient N in the cosN distribution for X and Z direction. \n :param x: float Range: 2 to 10 """ param = Conversions.decimal_value_to_str(x) self._core.io.write(f'ANTenna:MODel:ARRay:COSN:X {param}')
[docs] def get_z(self) -> float: """SCPI: ANTenna:MODel:ARRay:COSN:Z \n Snippet: value: float = driver.antenna.model.array.cosn.get_z() \n Requires ANTenna:MODel:ARRay:DISTribution:TYPE 1. Sets the individual value of the coefficient N in the cosN distribution for X and Z direction. \n :return: z: No help available """ response = self._core.io.query_str('ANTenna:MODel:ARRay:COSN:Z?') return Conversions.str_to_float(response)
[docs] def set_z(self, z: float) -> None: """SCPI: ANTenna:MODel:ARRay:COSN:Z \n Snippet: driver.antenna.model.array.cosn.set_z(z = 1.0) \n Requires ANTenna:MODel:ARRay:DISTribution:TYPE 1. Sets the individual value of the coefficient N in the cosN distribution for X and Z direction. \n :param z: float Range: 2 to 10 """ param = Conversions.decimal_value_to_str(z) self._core.io.write(f'ANTenna:MODel:ARRay:COSN:Z {param}')
[docs] def get_value(self) -> float: """SCPI: ANTenna:MODel:ARRay:COSN \n Snippet: value: float = driver.antenna.model.array.cosn.get_value() \n Sets the value of the coefficient N in the cosN distribution. \n :return: cosn: float Range: 2 to 10 """ response = self._core.io.query_str('ANTenna:MODel:ARRay:COSN?') return Conversions.str_to_float(response)
[docs] def set_value(self, cosn: float) -> None: """SCPI: ANTenna:MODel:ARRay:COSN \n Snippet: driver.antenna.model.array.cosn.set_value(cosn = 1.0) \n Sets the value of the coefficient N in the cosN distribution. \n :param cosn: float Range: 2 to 10 """ param = Conversions.decimal_value_to_str(cosn) self._core.io.write(f'ANTenna:MODel:ARRay:COSN {param}')