Package org.orekit.files.ccsds.definitions

Enum CenterName

java.lang.Object

java.lang.Enum<CenterName>

org.orekit.files.ccsds.definitions.CenterName

All Implemented Interfaces:

Serializable, Comparable<CenterName>

public enum CenterName
extends Enum<CenterName>

Orbit central bodies for which a Celestial body can be created.

Since:

6.1

Author:

sports

Enum Constant Summary

Enum Constants

Enum Constant	Description
EARTH	Earth body.
EARTH_MOON	Earth-Moon barycenter bodies pair.
JUPITER	Jupiter body.
MARS	Mars body.
MERCURY	Mercury body.
MOON	Moon body.
NEPTUNE	Neptune body.
PLUTO	Pluto body.
SATURN	Saturn body.
SOLAR_SYSTEM_BARYCENTER	Solar system barycenter aggregated body.
SUN	Sun body.
URANUS	Uranus body.
VENUS	Venus body.

Method Summary

Modifier and Type	Method	Description
CelestialBody	getCelestialBody()	Get the celestial body corresponding to the CCSDS constant.
CelestialBody	getCelestialBody(CelestialBodies celestialBodies)	Get the celestial body corresponding to the CCSDS constant.
static String	guessCenter(Frame frame)	Guess the name of the center of the reference frame.
static CenterName	map(Frame frame)	Map an Orekit frame to a CCSDS center.
static CenterName	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CenterName[]	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

SOLAR_SYSTEM_BARYCENTER

public static final CenterName SOLAR_SYSTEM_BARYCENTER

Solar system barycenter aggregated body.

SUN

public static final CenterName SUN

Sun body.

MERCURY

public static final CenterName MERCURY

Mercury body.

VENUS

public static final CenterName VENUS

Venus body.

EARTH_MOON

public static final CenterName EARTH_MOON

Earth-Moon barycenter bodies pair.

EARTH

public static final CenterName EARTH

Earth body.

MOON

public static final CenterName MOON

Moon body.

MARS

public static final CenterName MARS

Mars body.

JUPITER

public static final CenterName JUPITER

Jupiter body.

SATURN

public static final CenterName SATURN

Saturn body.

URANUS

public static final CenterName URANUS

Uranus body.

NEPTUNE

public static final CenterName NEPTUNE

Neptune body.

PLUTO

public static final CenterName PLUTO

Pluto body.

Method Detail

values

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

Returns:

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

valueOf

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

getCelestialBody

@DefaultDataContext
public CelestialBody getCelestialBody()

Get the celestial body corresponding to the CCSDS constant.

This method uses the default data context.

Returns:

celestial body corresponding to the CCSDS constant

See Also:

getCelestialBody(CelestialBodies)

getCelestialBody

public CelestialBody getCelestialBody(CelestialBodies celestialBodies)

Get the celestial body corresponding to the CCSDS constant.

Parameters:

celestialBodies - the set of celestial bodies to use.

Returns:

celestial body corresponding to the CCSDS constant

Since:

10.1

guessCenter

public static String guessCenter(Frame frame)

Guess the name of the center of the reference frame.

Parameters:

frame - a reference frame for ephemeris output.

Returns:

the string to use in the OEM file to describe the origin of frame.

map

public static CenterName map(Frame frame)

Map an Orekit frame to a CCSDS center.

Parameters:

frame - a reference frame.

Returns:

the string to use in the OEM file to describe the origin of frame, or null if no such center can be found