:orphan:

.. ****************************************************************************
.. CUI
..
.. The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
..
.. The use, dissemination or disclosure of data in this file is subject to
.. limitation or restriction. See accompanying README and LICENSE for details.
.. ****************************************************************************

.. _DisTransmitter:

DisTransmitter
--------------

.. class:: DisTransmitter inherits DisPdu

.. parsed-literal::

   :method:`DisTransmitter.EntityId`
   :method:`DisTransmitter.RadioId`
   :method:`DisTransmitter.RadioEntityType`
   :method:`DisTransmitter.TransmitState`
   :method:`DisTransmitter.InputSource`
   :method:`DisTransmitter.Location`
   :method:`DisTransmitter.RelativeLocation`
   :method:`DisTransmitter.AntennaPatternType`
   :method:`DisTransmitter.Frequency`
   :method:`DisTransmitter.FrequencyBandwidth`
   :method:`DisTransmitter.Power`
   :method:`DisTransmitter.ModulationType`
   :method:`DisTransmitter.CryptoSystem`
   :method:`DisTransmitter.CryptoKeyId`

Overview
========

DisTransmitter_ is an implementation of the DIS transmitter PDU.  Transmitter PDUs are used to communicate
information comm transmissions.

Methods
=======

.. method:: DisEntityId EntityId()
   
   Returns the ID of the subject platform.

.. method:: DisEventId EventId()
   
   Returns the ID associated with the transmitter event.

.. method:: int RadioId()
   
   Returns an identifier for the radio on the emitting entity.

.. method:: DisRadioEntityType RadioEntityType()
   
   Returns the radio entity type structure.

.. method:: int TransmitState()
   
   Returns the transmit state of the PDU.

.. method:: int InputSource()
   
   Returns the input source of the transmit event.

.. method:: Array<double> Location()
   
   Returns the location of the transmit event.  The location is in meters in a geocentric coordinate system.

.. method:: Array<double> RelativeLocation()
   
   Returns the location of the transmit event in parent body coordinates in meters.

.. method:: int AntennaPatternType()
   
   Returns an index associated with the antenna pattern type.

.. method:: int Frequency()
   
   Returns the frequency of the transmit.

.. method:: double FrequencyBandwidth()
   
   Return the frequency bandwidth of the transmit.

.. method:: double Power()
   
   Returns the power of the transmit.

.. method:: DisModulationType ModulationType()
   
   Returns the modulation type of the transmit.

.. method:: int CryptoSystem()
   
   Return an index associated with the crypto system used for the transmit.

.. method:: int CryptoKeyId()
   
   Returns an ID for the crypto system used for the transmit.