:orphan:

.. ****************************************************************************
.. CUI//REL TO USA ONLY
..
.. 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.
.. ****************************************************************************

WsfBMInterceptCalcResult
------------------------

.. class:: WsfBMInterceptCalcResult
   :cloneable:
   :constructible:

**WsfBMInterceptCalcResult** is the script interface for the return type to battle manager's intercept calculator interface. All intercept calculators are expected to meet the interface shown below. The intercept calculator may be employed on the battle manager processor or on a weapon platform. If there is no top-level intercept calculator on the battle manager processor, each weapon platform will be expected to provide it's own intercept calculator(with the same interface but on the platform using the weapon). For all battle manager capability, it is important to fill out all data in this structure if the intercept capability is set to true.

::

    # Intercept Calculator Interface Required Signature
    script WsfBMInterceptCalcResult can_intercept(WsfWeapon weapon, WsfTrack track)
     ...
    end_script


Methods
=======

.. method:: void SetCantIntercept()

   Marks intercept-capability as false(cannot intercept)

.. method:: void SetCanIntercept()

   Marks intercept-capability as true(can intercept)

.. method:: void SetCanIntercept(bool can_intercept)

   Marks intercept-capability as true if parameter is true, otherwise false.

.. method:: bool GetCanIntercept()

   Returns the intercept-capability flag: true if can intercept, otherwise false.

.. method:: void SetTTI(double time_to_intercept_secs)

   Sets the estimated time to execute the intercept in elapsed seconds.

.. method:: double GetTTI()

   Returns the estimated time to execute the intercept in elapsed seconds.

.. method:: void SetPredPoint(WsfGeoPoint predicted_pt)

   Sets the predicted intercept point.

.. method:: WsfGeoPoint GetPredPoint()

   Returns the predicted intercept point.

.. method:: void SetEstimatedPK(double estimated_pk)

   Sets the estimated probability of kill for the intercept.

.. method:: double GetEstimatedPK()

   Returns the estimated probability of kill for the intercept.

.. method:: void SetWeaponMaxRange(double estimated_pk)

   Sets the maximum weapon range for the given intercept geometry.

.. method:: double GetWeaponMaxRange()

   Returns the maximum weapon range for the given intercept geometry.