OrbitRelativeFrame (ORbit Extrapolation KIT 11.1.2 API)

java.lang.Object
- java.lang.Enum<OrbitRelativeFrame>
- - org.orekit.files.ccsds.definitions.OrbitRelativeFrame

All Implemented Interfaces:

Serializable, Comparable<OrbitRelativeFrame>
```
public enum OrbitRelativeFrame
extends Enum<OrbitRelativeFrame>
```
Frames used in CCSDS Orbit Data Messages.

Since:

11.0

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants
Enum Constant and 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

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 type with the specified name.
`static OrbitRelativeFrame[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - 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 Detail
  - values
```
public static OrbitRelativeFrame[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (OrbitRelativeFrame c : OrbitRelativeFrame.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static OrbitRelativeFrame valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type 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

Enum OrbitRelativeFrame

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EQW_INERTIAL

LVLH_ROTATING

LVLH_INERTIAL

LVLH

NSW_ROTATING

NSW_INERTIAL

NTW_ROTATING

NTW_INERTIAL

PQW_INERTIAL

RSW_ROTATING

RSW_INERTIAL

RSW

RIC

RTN

QSW

TNW_ROTATING

TNW_INERTIAL

TNW

SEZ_ROTATING

SEZ_INERTIAL

VNC_ROTATING

VNC_INERTIAL

Method Detail

values

valueOf

getLofType

isQuasiInertial