fr.cnes.sirius.patrius.orbits.orbitalparameters

Enum EquatorialCoordinate

java.lang.Object

java.lang.Enum<EquatorialCoordinate>

fr.cnes.sirius.patrius.orbits.orbitalparameters.EquatorialCoordinate

All Implemented Interfaces:

OrbitalCoordinate, Serializable, Comparable<EquatorialCoordinate>

public enum EquatorialCoordinate
extends Enum<EquatorialCoordinate>
implements OrbitalCoordinate

Enumerates the different types of coordinate associated with the equatorial parameters.

Author:

Hugo Veuillez (CNES), Thibaut Bonit (Thales Services)

Enum Constant Summary

Enum Constants

Enum Constant and Description
ECCENTRIC_ANOMALY Eccentric anomaly.
ECCENTRICITY Eccentricity.
I_X First component of inclination vector.
I_Y Second component of inclination vector.
MEAN_ANOMALY Mean anomaly.
PERIAPSIS_LONGITUDE Longitude of the periapsis.
SEMI_MAJOR_AXIS Semi-major axis.
TRUE_ANOMALY True anomaly.

Method Summary

Modifier and Type	Method and Description
OrbitType	getOrbitType() Gets the orbit type to which this orbital coordinate is related.
int	getStateVectorIndex() Gets the index of the coordinate in the state vector array.
static EquatorialCoordinate	valueOf(int stateVectorIndex, PositionAngle positionAngle) Gets the coordinate type associated with a given state vector index.
static EquatorialCoordinate	valueOf(String name) Returns the enum constant of this type with the specified name.
static EquatorialCoordinate[]	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

Methods inherited from interface fr.cnes.sirius.patrius.orbits.orbitalparameters.OrbitalCoordinate

checkStateVectorIndex, convertTo

Enum Constant Detail

SEMI_MAJOR_AXIS

public static final EquatorialCoordinate SEMI_MAJOR_AXIS

Semi-major axis.

ECCENTRICITY

public static final EquatorialCoordinate ECCENTRICITY

Eccentricity.

PERIAPSIS_LONGITUDE

public static final EquatorialCoordinate PERIAPSIS_LONGITUDE

Longitude of the periapsis.

I_X

public static final EquatorialCoordinate I_X

First component of inclination vector.

I_Y

public static final EquatorialCoordinate I_Y

Second component of inclination vector.

TRUE_ANOMALY

public static final EquatorialCoordinate TRUE_ANOMALY

True anomaly.

MEAN_ANOMALY

public static final EquatorialCoordinate MEAN_ANOMALY

Mean anomaly.

ECCENTRIC_ANOMALY

public static final EquatorialCoordinate ECCENTRIC_ANOMALY

Eccentric anomaly.

Method Detail

values

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

Returns:

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

valueOf

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

getStateVectorIndex

public int getStateVectorIndex()

Gets the index of the coordinate in the state vector array.

Specified by:

getStateVectorIndex in interface OrbitalCoordinate

Returns:

the index of the coordinate in the state vector array.

getOrbitType

public OrbitType getOrbitType()

Gets the orbit type to which this orbital coordinate is related.

Specified by:

getOrbitType in interface OrbitalCoordinate

Returns:

the orbit type to which this orbital coordinate is related

valueOf

public static EquatorialCoordinate valueOf(int stateVectorIndex,
                                           PositionAngle positionAngle)

Gets the coordinate type associated with a given state vector index.

Parameters:

stateVectorIndex - the state vector index

positionAngle - the position angle type (only used for the anomaly)

Returns:

the coordinate type associated with the provided state vector index

Throws:

IllegalArgumentException - if the provided state vector index is not between 0 and 5 (included)