: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.
.. ****************************************************************************

.. _DisFire:

DisFire
-------

.. class:: DisFire inherits DisPdu

.. parsed-literal::

   :method:`DisFire.FiringEntity`
   :method:`DisFire.TargetEntity`
   :method:`DisFire.WeaponEntity`
   :method:`DisFire.Event`
   :method:`DisFire.Location`
   :method:`DisFire.WeaponType`
   :method:`DisFire.Warhead`
   :method:`DisFire.Fuse`
   :method:`DisFire.Quantity`
   :method:`DisFire.Rate`
   :method:`DisFire.Velocity`
   :method:`DisFire.Range`

Overview
========

DisFire_ is an implementation of the DIS fire PDU.  Fire PDUs are used to indicate that a munition has been
fired from a platform.

Methods
=======

.. method:: DisEntityId FiringEntity()
   
   Returns the ID of the platform that fired the munition.

.. method:: DisEntityId TargetEntity()
   
   Returns the ID of the platform that is fired upon.

.. method:: DisEntityId WeaponEntity()
   
   Returns the ID of the platform representing the munition.

.. method:: DisEventId Event()
   
   Returns the event ID.  The event ID on the detonation PDU should be the same as one on the related :class:`DisDetonation`.

.. method:: Array <double> Location()
   
   Returns the location of the munition at time of detonation.  The location is in earth centered meters.

.. method:: DisEntityType WeaponType()
   
   Returns the type of the munition.

.. method:: int Warhead()
   
   Returns the warhead ID.

.. method:: int Fuse()
   
   Returns the fuse ID.

.. method:: int Quantity()
   
   Returns the quantity of munitions.

.. method:: int Rate()
   
   Returns the rate of detonation.

.. method:: Array <double> Velocity()
   
   Returns the velocity of the munition at time of detonation.  The velocity is in meters per second and earth centric
   coordinates.

.. method:: int Range()
   
   Returns the range for the event.