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

WSF_CYBER_WEAPONS_RETARGET_EFFECT 
---------------------------------

.. model:: cyber_effect WSF_CYBER_WEAPONS_RETARGET_EFFECT 

.. parsed-literal::

   cyber_effect <effect_name> :model:`WSF_CYBER_WEAPONS_RETARGET_EFFECT` 
   
   end_cyber_effect
   
Overview
========

:model:`WSF_CYBER_WEAPONS_RETARGET_EFFECT` is a cyber_effect that allows the attacker to redefine
the victim's current target by providing a new target via a track. Upon completion of the effect, the
original target of the victim will be restored. This effect does not prevent the change of the current target
while the effect is ongoing. This effect is not limited to weapon platforms, and can target any platform in the simulation.

This effect in no way alters the track update mechanism of the victim. Therefore, if this attack provides
altered data on the track provided, any future updates to the track will not be prevented. Note that if a false track is provided, there should not be any incoming track updates to contend with. The functionality 
for manipulating track data on a victim is expected in a future iteration of development.

This effect requires the passage of user supplied data via the :class:`WsfCyberAttackParameters` object at the time of attack call. This effect only allows a single user provided parameter
of type :class:`WsfTrack`. The string identifier for such data must match the name of this particular effect instantiation
**exactly** so that the effect can recognize which parameter is intended for it (since this may not be the only
effect requiring user supplied parameters).

.. warning:: This effect requires user supplied data during a CyberAttack initiation call. Anything passed for this effect beyond a single track is an error.

.. note:: This effect may have limited use unless the target has active guidance.

Commands
========
  
.. note:: This effect has no additional input. It only needs to be instantiated in a scenario for
          later use by the cyber_attack object. This effect requires additional input to a cyber_attack
          call by providing a retargeting track during the attack.