Package org.orekit.propagation.relative

Interface RelativeProvider

All Superinterfaces:
AdditionalDataProvider<double[]>
All Known Implementing Classes:
AbstractRelativeProvider, ClohessyWiltshireProvider, YamanakaAnkersenProvider
public interface RelativeProvider extends AdditionalDataProvider<double[]>
Interface for relative provider.

A relative provider is an interface extending AdditionalDataProvider to provide the relative state of a chaser S/C in regard to a target S/C as an AdditionalData. The target S/C is propagated with the "main" propagator where the additional data is added.

Since:
14.0
Author:
Romain Cuvillon

  • Method Details

    • getLof

      LOF getLof()
      Returns the LOF used by the provider.
      Returns:
      the LOF used by the provider

    • getInitialChaserPVTLof

      TimeStampedPVCoordinates getInitialChaserPVTLof()
      Get the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target.
      Returns:
      initial TimeStampedPVCoordinates of the chaser in target's LOF

    • setInitialChaserPVTLof

      void setInitialChaserPVTLof(TimeStampedPVCoordinates initialChaserPVTLof)
      Set the initial TimeStampedPVCoordinates of the chaser in the Local Orbital Frame of the target.
      Parameters:
      initialChaserPVTLof - initial TimeStampedPVCoordinates of the chaser in target's LOF

    • extractChaserPVT

      TimeStampedPVCoordinates extractChaserPVT(SpacecraftState targetState)
      Extracts the chaser's PVT in the target LOF from the given target SpacecraftState.
      Parameters:
      targetState - target SpacecraftState
      Returns:
      chaser's TimeStampedPVCoordinates in target's LOF

    • extractChaserPVT

      default TimeStampedPVCoordinates extractChaserPVT(SpacecraftState targetState, Frame outputFrame)
      Extracts the chaser's PVT from the given target SpacecraftState and converts it to the desired output frame.
      Parameters:
      targetState - target SpacecraftState
      outputFrame - desired frame in which to extract chaser's TimeStampedPVCoordinates
      Returns:
      TimeStampedPVCoordinates in desired frame

    • getAdditionalData

      default double[] getAdditionalData(SpacecraftState spacecraftState)
      Get the chaser state relative to a target, in target's LVLH LOF.
      Specified by:
      getAdditionalData in interface AdditionalDataProvider<double[]>
      Parameters:
      spacecraftState - spacecraft state to which additional data should correspond
      Returns:
      chaser Cartesian state in target's LVLH Local Orbital Frame.

    • getTargetOrbit

      Orbit getTargetOrbit()
      Get orbit of the target.
      Returns:
      orbit of the target

    • setTargetOrbit

      void setTargetOrbit(Orbit targetOrbit)
      Set orbit of the target.
      Parameters:
      targetOrbit - orbit of the target

    • setTargetTrueAnomaly

      default void setTargetTrueAnomaly(double trueAnomaly)
      CW doesn't use true anomaly, so default is a no-op Set the true anomaly of the target.
      Parameters:
      trueAnomaly - true anomaly of the target