Package org.orekit.files.ccsds.definitions

Enum Class CelestialBodyFrame

java.lang.Object

java.lang.Enum<CelestialBodyFrame>

org.orekit.files.ccsds.definitions.CelestialBodyFrame

All Implemented Interfaces:

Serializable, Comparable<CelestialBodyFrame>, Constable

public enum CelestialBodyFrame
extends Enum<CelestialBodyFrame>

Frames used in CCSDS Orbit Data Messages.

Since:

6.1

Author:

Steven Ports

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
EME2000	Earth Mean Equator and Equinox of J2000.
FIXED_EARTH	Fixed Earth frame (alias for ITRF).
GCRF	Geocentric Celestial Reference Frame.
GRC	Greenwich Rotating Coordinates.
GTOD	Greenwich True Of Date.
ICRF	International Celestial Reference Frame.
ITRF	Latest International Terrestrial 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.
TOD_EARTH	True of Date Earth frame (alias for TOD).
WGS84	WGS84 frame (alias for ITRF).

Method Summary

Modifier and Type	Method	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 class with the specified name.
static CelestialBodyFrame[]	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

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.

ITRF

public static final CelestialBodyFrame ITRF

Latest International Terrestrial 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.

FIXED_EARTH

public static final CelestialBodyFrame FIXED_EARTH

Fixed Earth frame (alias for ITRF).

Since:

14.0

WGS84

public static final CelestialBodyFrame WGS84

WGS84 frame (alias for ITRF).

Since:

14.0

TOD_EARTH

public static final CelestialBodyFrame TOD_EARTH

True of Date Earth frame (alias for TOD).

Since:

14.0

Method Details

values

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