fr.cnes.sirius.patrius.orbits.orbitalparameters

Enum ApsisAltitudeCoordinate

java.lang.Object

java.lang.Enum<ApsisAltitudeCoordinate>

fr.cnes.sirius.patrius.orbits.orbitalparameters.ApsisAltitudeCoordinate

All Implemented Interfaces:

OrbitalCoordinate, Serializable, Comparable<ApsisAltitudeCoordinate>

public enum ApsisAltitudeCoordinate
extends Enum<ApsisAltitudeCoordinate>
implements OrbitalCoordinate

Enumerates the different types of coordinate associated with the periapsis/apoapsis altitude parameters.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
APOAPSIS_ALTITUDE Altitude of the apoapsis.
ECCENTRIC_ANOMALY Eccentric anomaly.
INCLINATION Inclination.
MEAN_ANOMALY Mean anomaly.
PERIAPSIS_ALTITUDE Altitude of the periapsis.
PERIAPSIS_ARGUMENT Periapsis argument.
RIGHT_ASCENSION_OF_ASCENDING_NODE Right ascension of the ascending node.
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 ApsisAltitudeCoordinate	valueOf(int stateVectorIndex, PositionAngle positionAngle) Gets the coordinate type associated with a given state vector index.
static ApsisAltitudeCoordinate	valueOf(String name) Returns the enum constant of this type with the specified name.
static ApsisAltitudeCoordinate[]	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

PERIAPSIS_ALTITUDE

public static final ApsisAltitudeCoordinate PERIAPSIS_ALTITUDE

Altitude of the periapsis.

APOAPSIS_ALTITUDE

public static final ApsisAltitudeCoordinate APOAPSIS_ALTITUDE

Altitude of the apoapsis.

INCLINATION

public static final ApsisAltitudeCoordinate INCLINATION

Inclination.

PERIAPSIS_ARGUMENT

public static final ApsisAltitudeCoordinate PERIAPSIS_ARGUMENT

Periapsis argument.

RIGHT_ASCENSION_OF_ASCENDING_NODE

public static final ApsisAltitudeCoordinate RIGHT_ASCENSION_OF_ASCENDING_NODE

Right ascension of the ascending node.

TRUE_ANOMALY

public static final ApsisAltitudeCoordinate TRUE_ANOMALY

True anomaly.

MEAN_ANOMALY

public static final ApsisAltitudeCoordinate MEAN_ANOMALY

Mean anomaly.

ECCENTRIC_ANOMALY

public static final ApsisAltitudeCoordinate ECCENTRIC_ANOMALY

Eccentric anomaly.

Method Detail

values

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

Returns:

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

valueOf

public static ApsisAltitudeCoordinate 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 ApsisAltitudeCoordinate 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)