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

.. _DisComment:

DisComment
----------

.. class:: DisComment inherits DisPdu

.. parsed-literal::

   :method:`DisComment.ReceivingEntity`
   :method:`DisComment.OriginatingEntity`
   :method:`DisComment.String`

Overview
========

DisComment_ is an implementation of the DIS comment PDU.  Comment PDUs are used to pass information between
platforms in the simulation environment.

Methods
=======

.. method:: DisEntityId ReceivingEntity()
   
   Returns the ID of the platform receiving the comment.

.. method:: DisEntityId OriginatingEntity()
   
   Returns the ID of the platform sending the comment.

.. method:: string String()
   
   Returns the contents of the comment.