.. :html_theme.sidebar_secondary.remove:

:orphan:

:py:mod:`comyx.network.transceiver`
===================================

.. py:module:: comyx.network.transceiver


Module Summary
---------------

Classes
~~~~~~~

.. autoapisummary::

   comyx.network.transceiver.Transceiver





Reference
---------

.. py:class:: Transceiver(id_: str, n_antennas: int, position: Union[List[float], None] = None, t_power: Union[float, None] = None, r_sensitivity: Union[float, None] = None)


   Represents a transceiver in the modelled environment.

   Fundamental class of Comyx environments; can be used to model both the base
   stations and the mobile stations/users.

   All transceivers have a unique identifier, a position in the environment, number
   of antennas, and optionally a transmit power and a sensitivity. The transmit power
   is the power at which a transceiver transmits signals, and the sensitivity is the
   minimum power at which a transceiver can receive signals.

   .. py:property:: id
      :type: str

      Return the unique identifier of the transceiver.

   .. py:property:: n_antennas
      :type: int

      Return the number of antennas of the transceiver.

   .. py:property:: position
      :type: List[float]

      Return the position of the transceiver in the environment.

   .. py:property:: r_sensitivity
      :type: Union[float, None]

      Return the sensitivity of the transceiver.

   .. py:property:: t_power
      :type: Union[float, NDArrayFloat, None]

      Return the transmit power of the transceiver.