Package org.orekit.frames.encounter

Enum Class EncounterLOFType

java.lang.Object
java.lang.Enum<EncounterLOFType>
org.orekit.frames.encounter.EncounterLOFType
All Implemented Interfaces:
Serializable, Comparable<EncounterLOFType>, Constable
public enum EncounterLOFType extends Enum<EncounterLOFType>
Enum for encounter local orbital frame.
Since:
12.0
Author:
Vincent Cucchietti

  • Enum Constant Details

    • DEFAULT

      public static final EncounterLOFType DEFAULT
      Default encounter local orbital frame based on Figure 1.3 from Romain Serra's thesis.

      Note that it is up to the user to choose which object should be at the origin.

    • VALSECCHI

      public static final EncounterLOFType VALSECCHI
      Valsecchi encounter local orbital frame based on Valsecchi formulation from : "Valsecchi, G. B., Milani, A., Gronchi, G. F. & Ches- ley, S. R. Resonant returns to close approaches: Analytical theory. Astronomy & Astrophysics 408, 1179–1196 (2003)."

      Note that it is up to the user to choose which object should be at the origin.

  • Method Details

    • values

      public static EncounterLOFType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static EncounterLOFType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • getFrame

      public abstract EncounterLOF getFrame(PVCoordinates other)
      Get encounter local orbital frame associated to this enum.
      Parameters:
      other - other object position and velocity coordinates that is not the origin of the encounter frame
      Returns:
      encounter local orbital frame associated to this enum

    • getFrame

      public abstract <T extends CalculusFieldElement<T>> EncounterLOF getFrame(FieldPVCoordinates<T> other)
      Get encounter local orbital frame associated to this enum.
      Type Parameters:
      T - type of the field elements
      Parameters:
      other - other object position and velocity coordinates that is not the origin of the encounter frame
      Returns:
      encounter local orbital frame associated to this enum