org.orekit.files.ccsds

Enum CCSDSFrame

java.lang.Object

java.lang.Enum<CCSDSFrame>

org.orekit.files.ccsds.CCSDSFrame

All Implemented Interfaces:

Serializable, Comparable<CCSDSFrame>

public enum CCSDSFrame
extends Enum<CCSDSFrame>

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.
ICRF International Celestial Reference Frame.
ITRF2000 International Terrestrial Reference Frame 2000.
ITRF2005 International Terrestrial Reference Frame 2005.
ITRF2008 International Terrestrial Reference Frame 2008.
ITRF2014 International Terrestrial Reference Frame 2014.
ITRF93 International Terrestrial Reference Frame 1993.
ITRF97 International Terrestrial Reference Frame 1997.
MCI Mars Centered Inertial.
RSW Another name for Radial, Transverse (along-track) and Normal.
RTN Radial, Transverse (along-track) and Normal.
TDR True of Date, Rotating.
TEME True Equator Mean Equinox.
TNW TNW : x-axis along the velocity vector, W along the orbital angular momentum vector and N completes the right handed system.
TOD True of Date.

Method Summary

Modifier and Type	Method and Description
Frame	getFrame(IERSConventions conventions, boolean simpleEOP) Get the frame corresponding to the CCSDS constant.
Frame	getFrame(IERSConventions conventions, boolean simpleEOP, DataContext dataContext) Get the frame corresponding to the CCSDS constant.
LOFType	getLofType() Get the type of Local Orbital frame.
boolean	isLof() Check if the frame is a Local Orbital frame.
static CCSDSFrame	valueOf(String name) Returns the enum constant of this type with the specified name.
static CCSDSFrame[]	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 CCSDSFrame EME2000

Earth Mean Equator and Equinox of J2000.

GCRF

public static final CCSDSFrame GCRF

Geocentric Celestial Reference Frame.

GRC

public static final CCSDSFrame GRC

Greenwich Rotating Coordinates.

ICRF

public static final CCSDSFrame ICRF

International Celestial Reference Frame.

ITRF2014

public static final CCSDSFrame ITRF2014

International Terrestrial Reference Frame 2014.

ITRF2008

public static final CCSDSFrame ITRF2008

International Terrestrial Reference Frame 2008.

ITRF2005

public static final CCSDSFrame ITRF2005

International Terrestrial Reference Frame 2005.

ITRF2000

public static final CCSDSFrame ITRF2000

International Terrestrial Reference Frame 2000.

ITRF93

public static final CCSDSFrame ITRF93

International Terrestrial Reference Frame 1993.

ITRF97

public static final CCSDSFrame ITRF97

International Terrestrial Reference Frame 1997.

MCI

public static final CCSDSFrame MCI

Mars Centered Inertial.

TDR

public static final CCSDSFrame TDR

True of Date, Rotating.

TEME

public static final CCSDSFrame 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 CCSDSFrame TOD

True of Date.

RTN

public static final CCSDSFrame RTN

Radial, Transverse (along-track) and Normal.

RSW

public static final CCSDSFrame RSW

Another name for Radial, Transverse (along-track) and Normal.

TNW

public static final CCSDSFrame TNW

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

Method Detail

values

public static CCSDSFrame[] 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 (CCSDSFrame c : CCSDSFrame.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CCSDSFrame 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

isLof

public boolean isLof()

Check if the frame is a Local Orbital frame.

Returns:

true if the frame is a Local Orbital Frame

getLofType

public LOFType getLofType()

Get the type of Local Orbital frame.

If the frame is not a Local Orbital frame (i.e. if this method returns null), then the getFrame method must be used to retrieve the absolute frame.

Returns:

type of Local Orbital Frame, or null if the frame is not a local orbital frame

See Also:

isLof()

getFrame

@DefaultDataContext
public Frame getFrame(IERSConventions conventions,
                                          boolean simpleEOP)

Get the frame corresponding to the CCSDS constant.

This method uses the default data context.

Parameters:

conventions - IERS conventions to use

simpleEOP - if true, tidal effects are ignored when interpolating EOP

Returns:

frame corresponding to the CCSDS constant

See Also:

isLof(), getFrame(IERSConventions, boolean, DataContext)

getFrame

public 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

See Also:

isLof()