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

WsfChangeEccentricity
---------------------

.. class:: WsfChangeEccentricity inherits WsfOrbitalManeuver

**Input type:** :doc:`change_eccentricity<../change_eccentricity>`

WsfChangeEccentricity_ can be used to change the eccentricity of an orbit of a platform.

.. method:: static WsfChangeEccentricity Construct(WsfOrbitalEventCondition aCondition, double aEccentricity)

   Static method to create a WsfChangeEccentricity_ using a specific condition and the desired eccentricity [0..1] (must be less than 1) of the orbit.

.. note:: When the current eccentricity is not 0, the condition supplied must
          be :method:`WsfOrbitalEventCondition.AT_PERIAPSIS` or :method:`WsfOrbitalEventCondition.AT_APOAPSIS`.