RFEnvironment
=============

.. py:class:: ansys.stk.core.stkobjects.RFEnvironment

   Class defining the RF environment.

.. py:currentmodule:: RFEnvironment

Overview
--------

.. tab-set::

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.propagation_channel`
              - Get the propagation channel.
            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.supported_contour_rain_outage_percent_values`
              - Get an array of supported contour rain outage percent values.
            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.contour_rain_outage_percent`
              - Get or set the contour rain outage percent.
            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.earth_temperature`
              - Get or set the earth temperature.
            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.supported_active_comm_systems`
              - Get an array of supported active CommSystem objects.
            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.active_comm_system`
              - Get or set the active CommSystem object.
            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.magnetic_north_pole_latitude`
              - Get or set magnetic north pole latitude.
            * - :py:attr:`~ansys.stk.core.stkobjects.RFEnvironment.magnetic_north_pole_longitude`
              - Get or set magnetic north pole longitude.



Import detail
-------------

.. code-block:: python

    from ansys.stk.core.stkobjects import RFEnvironment


Property detail
---------------

.. py:property:: propagation_channel
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.propagation_channel
    :type: PropagationChannel

    Get the propagation channel.

.. py:property:: supported_contour_rain_outage_percent_values
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.supported_contour_rain_outage_percent_values
    :type: list

    Get an array of supported contour rain outage percent values.

.. py:property:: contour_rain_outage_percent
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.contour_rain_outage_percent
    :type: float

    Get or set the contour rain outage percent.

.. py:property:: earth_temperature
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.earth_temperature
    :type: float

    Get or set the earth temperature.

.. py:property:: supported_active_comm_systems
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.supported_active_comm_systems
    :type: list

    Get an array of supported active CommSystem objects.

.. py:property:: active_comm_system
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.active_comm_system
    :type: str

    Get or set the active CommSystem object.

.. py:property:: magnetic_north_pole_latitude
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.magnetic_north_pole_latitude
    :type: float

    Get or set magnetic north pole latitude.

.. py:property:: magnetic_north_pole_longitude
    :canonical: ansys.stk.core.stkobjects.RFEnvironment.magnetic_north_pole_longitude
    :type: float

    Get or set magnetic north pole longitude.