Package org.orekit.rugged.api

Enum BodyRotatingFrameId

java.lang.Object

java.lang.Enum<BodyRotatingFrameId>

org.orekit.rugged.api.BodyRotatingFrameId

All Implemented Interfaces:

Serializable, Comparable<BodyRotatingFrameId>

public enum BodyRotatingFrameId
extends Enum<BodyRotatingFrameId>

Enumerate for body rotating frames.

Author:

Luc Maisonobe

Enum Constant Summary

Enum Constants

Enum Constant	Description
GTOD	Constant for Geocentric True Of Date frame.
ITRF	Constant for International Terrestrial Reference Frame.
ITRF_EQUINOX	Constant for International Terrestrial Reference Frame based on older equinox paradigm.

Method Summary

Modifier and Type	Method	Description
static BodyRotatingFrameId	valueOf(String name)	Returns the enum constant of this type with the specified name.
static BodyRotatingFrameId[]	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

ITRF

public static final BodyRotatingFrameId ITRF

Constant for International Terrestrial Reference Frame.

ITRF_EQUINOX

public static final BodyRotatingFrameId ITRF_EQUINOX

Constant for International Terrestrial Reference Frame based on older equinox paradigm.

GTOD

public static final BodyRotatingFrameId GTOD

Constant for Geocentric True Of Date frame.

Method Detail

values

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

Returns:

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

valueOf

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