CelestialBodyFrame (ORbit Extrapolation KIT 11.2.1 API)

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

All Implemented Interfaces:

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

Since:

6.1

Author:

Steven Ports

Enum Constant Summary

Enum Constants
Enum Constant and Description
`EME2000` Earth Mean Equator and Equinox of J2000.
`GCRF` Geocentric Celestial Reference Frame.
`GRC` Greenwich Rotating Coordinates.
`GTOD` Greenwich True Of Date.
`ICRF` International Celestial Reference Frame.
`ITRF1988` International Terrestrial Reference Frame 1988.
`ITRF1989` International Terrestrial Reference Frame 1989.
`ITRF1990` International Terrestrial Reference Frame 1990.
`ITRF1991` International Terrestrial Reference Frame 1991.
`ITRF1992` International Terrestrial Reference Frame 1992.
`ITRF1993` International Terrestrial Reference Frame 1993.
`ITRF1994` International Terrestrial Reference Frame 1994.
`ITRF1996` International Terrestrial Reference Frame 1996.
`ITRF1997` International Terrestrial Reference Frame 1997.
`ITRF2000` International Terrestrial Reference Frame 2000.
`ITRF2005` International Terrestrial Reference Frame 2005.
`ITRF2008` International Terrestrial Reference Frame 2008.
`ITRF2014` International Terrestrial Reference Frame 2014.
`ITRF2020` International Terrestrial Reference Frame 2020.
`J2000` Earth Mean Equator and Equinox of J2000.
`MCI` Mars Centered Inertial.
`TDR` True of Date, Rotating.
`TEME` True Equator Mean Equinox.
`TOD` True of Date.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract Frame`	`getFrame(IERSConventions conventions, boolean simpleEOP, DataContext dataContext)` Get the frame corresponding to the CCSDS constant.
`String`	`getName()` Get the name of celestial body frame.
`static String`	`guessFrame(Frame frame)` Guesses names from ODM Table 5-3 and Annex A.
`static CelestialBodyFrame`	`map(Frame frame)` Map an Orekit frame to a CCSDS frame.
`static CelestialBodyFrame`	`parse(String frameName)` Parse a CCSDS frame.
`static CelestialBodyFrame`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static CelestialBodyFrame[]`	`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
  - EME2000
```
public static final CelestialBodyFrame EME2000
```
    Earth Mean Equator and Equinox of J2000.
  - J2000
```
public static final CelestialBodyFrame J2000
```
    Earth Mean Equator and Equinox of J2000.
  - GCRF
```
public static final CelestialBodyFrame GCRF
```
    Geocentric Celestial Reference Frame.
  - GRC
```
public static final CelestialBodyFrame GRC
```
    Greenwich Rotating Coordinates.
  - GTOD
```
public static final CelestialBodyFrame GTOD
```
    Greenwich True Of Date.
    
    Since:
    
    11.0
  - ICRF
```
public static final CelestialBodyFrame ICRF
```
    International Celestial Reference Frame.
  - ITRF2020
```
public static final CelestialBodyFrame ITRF2020
```
    International Terrestrial Reference Frame 2020.
  - ITRF2014
```
public static final CelestialBodyFrame ITRF2014
```
    International Terrestrial Reference Frame 2014.
  - ITRF2008
```
public static final CelestialBodyFrame ITRF2008
```
    International Terrestrial Reference Frame 2008.
  - ITRF2005
```
public static final CelestialBodyFrame ITRF2005
```
    International Terrestrial Reference Frame 2005.
  - ITRF2000
```
public static final CelestialBodyFrame ITRF2000
```
    International Terrestrial Reference Frame 2000.
  - ITRF1997
```
public static final CelestialBodyFrame ITRF1997
```
    International Terrestrial Reference Frame 1997.
  - ITRF1996
```
public static final CelestialBodyFrame ITRF1996
```
    International Terrestrial Reference Frame 1996.
  - ITRF1994
```
public static final CelestialBodyFrame ITRF1994
```
    International Terrestrial Reference Frame 1994.
  - ITRF1993
```
public static final CelestialBodyFrame ITRF1993
```
    International Terrestrial Reference Frame 1993.
  - ITRF1992
```
public static final CelestialBodyFrame ITRF1992
```
    International Terrestrial Reference Frame 1992.
  - ITRF1991
```
public static final CelestialBodyFrame ITRF1991
```
    International Terrestrial Reference Frame 1991.
  - ITRF1990
```
public static final CelestialBodyFrame ITRF1990
```
    International Terrestrial Reference Frame 1990.
  - ITRF1989
```
public static final CelestialBodyFrame ITRF1989
```
    International Terrestrial Reference Frame 1989.
  - ITRF1988
```
public static final CelestialBodyFrame ITRF1988
```
    International Terrestrial Reference Frame 1988.
  - MCI
```
public static final CelestialBodyFrame MCI
```
    Mars Centered Inertial.
  - TDR
```
public static final CelestialBodyFrame TDR
```
    True of Date, Rotating.
  - TEME
```
public static final CelestialBodyFrame TEME
```
    True Equator Mean Equinox. TEME may be used only for OMMs based on NORAD Two Line Element sets, and in no other circumstances.
  - TOD
```
public static final CelestialBodyFrame TOD
```
    True of Date.
- Method Detail
  - values
```
public static CelestialBodyFrame[] 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 (CelestialBodyFrame c : CelestialBodyFrame.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static CelestialBodyFrame 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
  - getFrame
```
public abstract Frame getFrame(IERSConventions conventions,
                               boolean simpleEOP,
                               DataContext dataContext)
```
    Get the frame corresponding to the CCSDS constant.
    
    Parameters:
    
    conventions - IERS conventions to use
    
    simpleEOP - if true, tidal effects are ignored when interpolating EOP
    
    dataContext - to use when creating the frame.
    
    Returns:
    
    frame corresponding to the CCSDS constant
    
    Since:
    
    10.1
  - getName
```
public String getName()
```
    Get the name of celestial body frame.
    
    Returns:
    
    the name of celestial body frame
    
    Since:
    
    11.1
  - parse
```
public static CelestialBodyFrame parse(String frameName)
```
    Parse a CCSDS frame.
    
    Parameters:
    
    frameName - name of the frame, as the value of a CCSDS key=value line
    
    Returns:
    
    CCSDS frame corresponding to the name
  - map
```
public static CelestialBodyFrame map(Frame frame)
```
    Map an Orekit frame to a CCSDS frame.
    The goal of this method is to perform the opposite mapping of getFrame(IERSConventions, boolean, DataContext).
    
    Parameters:
    
    frame - a reference frame.
    
    Returns:
    
    the CCSDSFrame corresponding to the Orekit frame
  - guessFrame
```
public static String guessFrame(Frame frame)
```
    Guesses names from ODM Table 5-3 and Annex A.
    The goal of this method is to perform the opposite mapping of getFrame(IERSConventions, boolean, DataContext).
    
    Parameters:
    
    frame - a reference frame.
    
    Returns:
    
    the string to use in the OEM file to identify frame.

Enum CelestialBodyFrame

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

EME2000

J2000

GCRF

GRC

GTOD

ICRF

ITRF2020

ITRF2014

ITRF2008

ITRF2005

ITRF2000

ITRF1997

ITRF1996

ITRF1994

ITRF1993

ITRF1992

ITRF1991

ITRF1990

ITRF1989

ITRF1988

MCI

TDR

TEME

TOD

Method Detail

values

valueOf

getFrame

getName

parse

map

guessFrame