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

WsfFormationChangeLeadSubCommand
--------------------------------

.. class:: WsfFormationChangeLeadSubCommand inherits WsfFormationCommand

:class:`WsfFormationChangeLeadSubCommand` will change the lead sub-formation
of the formation to which the command is assigned. After the change in leader,
the attached members of the formation will update their station keeping to
account for the new leader.

Methods
=======

.. method:: WsfFormationChangeLeadSubCommand Construct(string aNewLeadName)

   Construct a command that will set the lead sub-formation to the sub-formation
   with the given relative name for the formation to which the command is
   assigned.

.. method:: string GetNewLeaderName()

   Return the relative name that would be the new lead sub-formation for the 
   formation to which this command is assigned.