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

.. _DisPdu:

DisPdu
------

.. class:: DisPdu

.. parsed-literal::

   :class:`DisComment`
   :class:`DisDetonation`
   :class:`DisEmission`
   :class:`DisEntityState`
   :class:`DisFire`
   :class:`DisReceiver`
   :class:`DisTransmitter`

.. parsed-literal::

   :method:`DisPdu.ProtocolVersion`
   :method:`DisPdu.Exercise`
   :method:`DisPdu.PduType`
   :method:`DisPdu.ProtocolFamily`
   :method:`DisPdu.TimeStamp`
   :method:`DisPdu.BaseLength`
   :method:`DisPdu.Length`

Overview
========

DisPdu_ is an implementation of a generic DIS PDU.  PDUs are used to communicate information between simulations on
a DIS network.

Methods
=======

.. method:: int ProtocolVersion()
   
   Returns the DIS Protocol version.

.. method:: int Exercise()
   
   Returns the DIS exercise ID.

.. method:: int PduType()
   
   Returns the type of PDU.
   
   | 1. :class:`DisEntityState`
   | 2. :class:`DisFire`
   | 3. :class:`DisDetonation`
   | 22. :class:`DisComment`
   | 23. :class:`DisEmission`
   | 25. :class:`DisTransmitter`
   | 27. :class:`DisReceiver`
  
.. method:: int ProtocolFamily()
   
   Returns the DIS Protocol family.

.. method:: int TimeStamp()
   
   Returns the timestamp for the PDU.

.. method:: int BaseLength()
   
   Returns the length of the generic DIS PDU, excluding type-specific information.

.. method:: int Length()
   
   Returns the length of the entire DIS PDU, including type-specific information.