Package org.orekit.files.ccsds.definitions

Enum Class OrbitRelativeFrame

java.lang.Object
java.lang.Enum<OrbitRelativeFrame>
org.orekit.files.ccsds.definitions.OrbitRelativeFrame
All Implemented Interfaces:
Serializable, Comparable<OrbitRelativeFrame>, Constable
public enum OrbitRelativeFrame extends Enum<OrbitRelativeFrame>
Frames used in CCSDS Orbit Data Messages.
Since:
11.0
Author:
Luc Maisonobe

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • Enum Constant Summary

    Enum Constants
    Enum Constant
    Description
    EQW_INERTIAL
    Equinoctial coordinate system (X towards ascending node, Z towards momentum).
    LVLH
    Local vertical, Local Horizontal (Z towards nadir, Y opposite to momentum).
    LVLH_INERTIAL
    Local vertical, Local Horizontal (Z towards nadir, Y opposite to momentum).
    LVLH_ROTATING
    Local vertical, Local Horizontal (Z towards nadir, Y opposite to momentum).
    NSW_INERTIAL
    Nadir, Sun, Normal (X towards nadir, Y as close to Sun as possible).
    NSW_ROTATING
    Nadir, Sun, Normal (X towards nadir, Y as close to Sun as possible).
    NTW_INERTIAL
    Transverse Velocity Normal coordinate system (Y towards velocity, Z towards momentum).
    NTW_ROTATING
    Transverse Velocity Normal coordinate system (Y towards velocity, Z towards momentum).
    PQW_INERTIAL
    Perifocal coordinate system (X towards periapsis, Z towards momentum).
    QSW
    Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).
    RIC
    Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).
    RSW
    Another name for Radial, Transverse (along-track) and Normal.
    RSW_INERTIAL
    Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).
    RSW_ROTATING
    Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).
    RTN
    Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).
    SEZ_INERTIAL
    South, East, Zenith coordinate system.
    SEZ_ROTATING
    South, East, Zenith coordinate system.
    TNW
    TNW : x-axis along the velocity vector, W along the orbital angular momentum vector and N completes the right-handed system.
    TNW_INERTIAL
    Tangential, Normal, Cross-track coordinate system (X towards velocity, Z towards momentum).
    TNW_ROTATING
    Tangential, Normal, Cross-track coordinate system (X towards velocity, Z towards momentum).
    VNC_INERTIAL
    Velocity, Normal, Co-normal coordinate system (X towards velocity, Y towards momentum).
    VNC_ROTATING
    Velocity, Normal, Co-normal coordinate system (X towards velocity, Y towards momentum).

  • Method Summary

    Modifier and Type
    Method
    Description
    LOFType
    getLofType()
    Get the type of Local Orbital frame.
    boolean
    isQuasiInertial()
    Check if frame should be treated as inertial.
    static OrbitRelativeFrame
    valueOf(String name)
    Returns the enum constant of this class with the specified name.
    static OrbitRelativeFrame[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • EQW_INERTIAL

      public static final OrbitRelativeFrame EQW_INERTIAL
      Equinoctial coordinate system (X towards ascending node, Z towards momentum).

    • LVLH_ROTATING

      public static final OrbitRelativeFrame LVLH_ROTATING
      Local vertical, Local Horizontal (Z towards nadir, Y opposite to momentum).

    • LVLH_INERTIAL

      public static final OrbitRelativeFrame LVLH_INERTIAL
      Local vertical, Local Horizontal (Z towards nadir, Y opposite to momentum).

    • LVLH

      public static final OrbitRelativeFrame LVLH
      Local vertical, Local Horizontal (Z towards nadir, Y opposite to momentum).

    • NSW_ROTATING

      public static final OrbitRelativeFrame NSW_ROTATING
      Nadir, Sun, Normal (X towards nadir, Y as close to Sun as possible).

    • NSW_INERTIAL

      public static final OrbitRelativeFrame NSW_INERTIAL
      Nadir, Sun, Normal (X towards nadir, Y as close to Sun as possible).

    • NTW_ROTATING

      public static final OrbitRelativeFrame NTW_ROTATING
      Transverse Velocity Normal coordinate system (Y towards velocity, Z towards momentum).

    • NTW_INERTIAL

      public static final OrbitRelativeFrame NTW_INERTIAL
      Transverse Velocity Normal coordinate system (Y towards velocity, Z towards momentum).

    • PQW_INERTIAL

      public static final OrbitRelativeFrame PQW_INERTIAL
      Perifocal coordinate system (X towards periapsis, Z towards momentum).

    • RSW_ROTATING

      public static final OrbitRelativeFrame RSW_ROTATING
      Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).

    • RSW_INERTIAL

      public static final OrbitRelativeFrame RSW_INERTIAL
      Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).

    • RSW

      public static final OrbitRelativeFrame RSW
      Another name for Radial, Transverse (along-track) and Normal.

    • RIC

      public static final OrbitRelativeFrame RIC
      Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).

    • RTN

      public static final OrbitRelativeFrame RTN
      Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).

    • QSW

      public static final OrbitRelativeFrame QSW
      Another name for Radial, Transverse (along-track) and Normal (X towards zenith, Z towards momentum).

    • TNW_ROTATING

      public static final OrbitRelativeFrame TNW_ROTATING
      Tangential, Normal, Cross-track coordinate system (X towards velocity, Z towards momentum).

    • TNW_INERTIAL

      public static final OrbitRelativeFrame TNW_INERTIAL
      Tangential, Normal, Cross-track coordinate system (X towards velocity, Z towards momentum).

    • TNW

      public static final OrbitRelativeFrame TNW
      TNW : x-axis along the velocity vector, W along the orbital angular momentum vector and N completes the right-handed system.

    • SEZ_ROTATING

      public static final OrbitRelativeFrame SEZ_ROTATING
      South, East, Zenith coordinate system.

    • SEZ_INERTIAL

      public static final OrbitRelativeFrame SEZ_INERTIAL
      South, East, Zenith coordinate system.

    • VNC_ROTATING

      public static final OrbitRelativeFrame VNC_ROTATING
      Velocity, Normal, Co-normal coordinate system (X towards velocity, Y towards momentum).

    • VNC_INERTIAL

      public static final OrbitRelativeFrame VNC_INERTIAL
      Velocity, Normal, Co-normal coordinate system (X towards velocity, Y towards momentum).

  • Method Details

    • values

      public static OrbitRelativeFrame[] 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 OrbitRelativeFrame 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

    • getLofType

      public LOFType getLofType()
      Get the type of Local Orbital frame.
      Returns:
      type of Local Orbital Frame, or null if the frame is not a local orbital frame

    • isQuasiInertial

      public boolean isQuasiInertial()
      Check if frame should be treated as inertial.

      A frame treated as an inertial coordinate system if it is considered to be redefined at each time of interest

      Returns:
      true if frame should be treated as inertial