PropagatorUserExternal
======================

.. py:class:: ansys.stk.core.stkobjects.PropagatorUserExternal

   Bases: :py:class:`~ansys.stk.core.stkobjects.IPropagator`

   Class defining the user-external propagator.

.. py:currentmodule:: PropagatorUserExternal

Overview
--------

.. tab-set::

    .. tab-item:: Methods

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.propagate`
              - Propagates the vehicle's path using the specified time interval.

    .. tab-item:: Properties

        .. list-table::
            :header-rows: 0
            :widths: auto

            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.start_time`
              - Get or set the start time of ephemeris interval. Uses DateFormat Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.stop_time`
              - Get or set the stop time of ephemeris interval. Uses DateFormat Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.step`
              - Step size. Uses Time Dimension.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.propagator`
              - Propagator.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.file`
              - Name of user-external file.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.vehicle_id`
              - Vehicle ID.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.description`
              - Description.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.available_vehicle_identifiers`
              - Get available IDs.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.available_propagators`
              - Get available propagators.
            * - :py:attr:`~ansys.stk.core.stkobjects.PropagatorUserExternal.ephemeris_interval`
              - Get the propagator's ephemeris interval.



Import detail
-------------

.. code-block:: python

    from ansys.stk.core.stkobjects import PropagatorUserExternal


Property detail
---------------

.. py:property:: start_time
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.start_time
    :type: typing.Any

    Get or set the start time of ephemeris interval. Uses DateFormat Dimension.

.. py:property:: stop_time
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.stop_time
    :type: typing.Any

    Get or set the stop time of ephemeris interval. Uses DateFormat Dimension.

.. py:property:: step
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.step
    :type: float

    Step size. Uses Time Dimension.

.. py:property:: propagator
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.propagator
    :type: str

    Propagator.

.. py:property:: file
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.file
    :type: str

    Name of user-external file.

.. py:property:: vehicle_id
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.vehicle_id
    :type: str

    Vehicle ID.

.. py:property:: description
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.description
    :type: str

    Description.

.. py:property:: available_vehicle_identifiers
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.available_vehicle_identifiers
    :type: list

    Get available IDs.

.. py:property:: available_propagators
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.available_propagators
    :type: list

    Get available propagators.

.. py:property:: ephemeris_interval
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.ephemeris_interval
    :type: ITimeToolTimeIntervalSmartInterval

    Get the propagator's ephemeris interval.


Method detail
-------------

.. py:method:: propagate(self) -> None
    :canonical: ansys.stk.core.stkobjects.PropagatorUserExternal.propagate

    Propagates the vehicle's path using the specified time interval.

    :Returns:

        :obj:`~None`