fr.cnes.sirius.patrius.orbits.orbitalparameters

Enum EquinoctialCoordinate

java.lang.Object

java.lang.Enum<EquinoctialCoordinate>

fr.cnes.sirius.patrius.orbits.orbitalparameters.EquinoctialCoordinate

All Implemented Interfaces:

OrbitalCoordinate, Serializable, Comparable<EquinoctialCoordinate>

public enum EquinoctialCoordinate
extends Enum<EquinoctialCoordinate>
implements OrbitalCoordinate

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

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
E_X First component of the eccentricity vector.
E_Y Second component of the eccentricity vector.
ECCENTRIC_LONGITUDE_ARGUMENT Eccentric longitude argument.
H_X First component of the inclination vector.
H_Y Second component of the inclination vector.
MEAN_LONGITUDE_ARGUMENT Mean longitude argument.
SEMI_MAJOR_AXIS Semi-major axis.
TRUE_LONGITUDE_ARGUMENT True longitude argument.

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 EquinoctialCoordinate	valueOf(int stateVectorIndex, PositionAngle positionAngle) Gets the coordinate type associated with a given state vector index.
static EquinoctialCoordinate	valueOf(String name) Returns the enum constant of this type with the specified name.
static EquinoctialCoordinate[]	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 EquinoctialCoordinate SEMI_MAJOR_AXIS

Semi-major axis.

E_X

public static final EquinoctialCoordinate E_X

First component of the eccentricity vector.

E_Y

public static final EquinoctialCoordinate E_Y

Second component of the eccentricity vector.

H_X

public static final EquinoctialCoordinate H_X

First component of the inclination vector.

H_Y

public static final EquinoctialCoordinate H_Y

Second component of the inclination vector.

TRUE_LONGITUDE_ARGUMENT

public static final EquinoctialCoordinate TRUE_LONGITUDE_ARGUMENT

True longitude argument.

MEAN_LONGITUDE_ARGUMENT

public static final EquinoctialCoordinate MEAN_LONGITUDE_ARGUMENT

Mean longitude argument.

ECCENTRIC_LONGITUDE_ARGUMENT

public static final EquinoctialCoordinate ECCENTRIC_LONGITUDE_ARGUMENT

Eccentric longitude argument.

Method Detail

values

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

Returns:

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

valueOf

public static EquinoctialCoordinate 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 EquinoctialCoordinate 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 longitude argument)

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)