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

.. _DisBeam:

DisBeam
-------

.. class:: DisBeam

.. parsed-literal::

   :method:`DisBeam.GetDataLength`
   :method:`DisBeam.GetBeamId`
   :method:`DisBeam.GetIndex`
   :method:`DisBeam.GetFrequency`
   :method:`DisBeam.GetFrequencyRange`
   :method:`DisBeam.GetEffectiveRadiatedPower`
   :method:`DisBeam.GetPulseRepetitionFrequency`
   :method:`DisBeam.GetPulseWidth`
   :method:`DisBeam.GetAzimuthCenter`
   :method:`DisBeam.GetAzimuthSweep`
   :method:`DisBeam.GetElevationCenter`
   :method:`DisBeam.GetElevationSweep`
   :method:`DisBeam.GetSweepSync`
   :method:`DisBeam.GetFunction`
   :method:`DisBeam.GetTrackJamCount`
   :method:`DisBeam.GetHighDensityTrackJam`
   :method:`DisBeam.GetJammingModeSequence`

Overview
========

DisBeam_ is an implementation of the DIS Beam.

Methods
=======

.. method:: int GetDataLength()
   
   Returns the length of the DIS Beam structure.

.. method:: int GetBeamId()
   
   Returns the DIS ID associated with the beam.

.. method:: int GetIndex()
   
   Returns an index associated with the beam in the DIS Emissions PDU.

.. method:: double GetFrequency()
   
   Returns the frequency of the beam.

.. method:: double GetFrequencyRange()
   
   Returns the frequency range of the DIS beam.

.. method:: double GetEffectiveRadiatedPower()
   
   Returns the effective radiated power of the beam.

.. method:: double GetPulseRepetitionFrequency()
   
   Returns the pulse repetition frequency of the beam.

.. method:: double GetPulseWidth()
   
   Returns the pulse width of the beam.

.. method:: double GetAzimuthCenter()
   
   Returns the center line azimuth of the beam.

.. method:: double GetAzimuthSweep()
   
   Returns the sweep angle of the beam along azimuth.

.. method:: double GetElevationCenter()
   
   Returns the beam's center angle in elevation

.. method:: double GetElevationSweep()
   
   Returns the sweep angle of the beam along elevation.

.. method:: double GetSweepSync()
   
   Returns the beam's sweep synchronization value.

.. method:: int GetFunction()
   
   Returns the beam's function value.

.. method:: int GetTrackJamCount()
   
   Returns the number of tracks or jams occurring on the beam.

.. method:: int GetHighDensityTrackJam()
   
   Returns the high density track jam value.

.. method:: int GetJammingModeSequence()
   
   Returns the jamming mode sequence value.