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

WsfESM_Sensor
-------------

.. class:: WsfESM_Sensor inherits WsfSensor

Methods
=======

The scripting capability in the :model:`WSF_ESM_SENSOR` Class allows for an analyst to modify certain parameters of an :model:`WSF_ESM_SENSOR` during run-time. The following command are available for :model:`WSF_ESM_SENSOR` types:

.. method:: int FrequencyBandCount(string aMode, int aBeam)

   Returns the number of frequency bands contained in the receiver for a given sensor mode and antenna beam.

.. method:: bool TuneFrequencyBand(bool aReset, string aMode, int aBeamNum, int aFrequencyBandNumber, \
                                   double aLowerFrequencyLimit, double aUpperFrequencyLimit, double aDwellTime, \
                                   double aRevisitTime)

   Either adds a new frequency band or retunes an existing frequency band for a given mode-beam combination.
   Parameter "aReset" controls whether the call from script will wither ADD a new Band or RESET an existing Band. Values
   are either 'false' or 'true', which ADDS or RESETS, respectively. Frequency units are expected to be hertz, and time
   units are in seconds. The dwell and revisit times must follow the conventions as defined in the :model:`WSF_ESM_SENSOR`. If
   the frequency band is being added then previously defined dwell and revisit times must be of the same type, if using
   the scan on scan model.