fr.cnes.sirius.patrius.orbits.orbitalparameters

Enum CircularCoordinate

java.lang.Object

java.lang.Enum<CircularCoordinate>

fr.cnes.sirius.patrius.orbits.orbitalparameters.CircularCoordinate

All Implemented Interfaces:

OrbitalCoordinate, Serializable, Comparable<CircularCoordinate>

public enum CircularCoordinate
extends Enum<CircularCoordinate>
implements OrbitalCoordinate

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

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
E_X First component of circular eccentricity vector.
E_Y Second component of circular eccentricity vector.
ECCENTRIC_LATITUDE_ARGUMENT Eccentric latitude argument.
INCLINATION Inclination.
MEAN_LATITUDE_ARGUMENT Mean latitude argument.
RIGHT_ASCENSION_OF_ASCENDING_NODE Right ascension of the ascending node.
SEMI_MAJOR_AXIS Semi-major axis.
TRUE_LATITUDE_ARGUMENT True latitude 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 CircularCoordinate	valueOf(int stateVectorIndex, PositionAngle positionAngle) Gets the coordinate type associated with a given state vector index.
static CircularCoordinate	valueOf(String name) Returns the enum constant of this type with the specified name.
static CircularCoordinate[]	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 CircularCoordinate SEMI_MAJOR_AXIS

Semi-major axis.

E_X

public static final CircularCoordinate E_X

First component of circular eccentricity vector.

E_Y

public static final CircularCoordinate E_Y

Second component of circular eccentricity vector.

INCLINATION

public static final CircularCoordinate INCLINATION

Inclination.

RIGHT_ASCENSION_OF_ASCENDING_NODE

public static final CircularCoordinate RIGHT_ASCENSION_OF_ASCENDING_NODE

Right ascension of the ascending node.

TRUE_LATITUDE_ARGUMENT

public static final CircularCoordinate TRUE_LATITUDE_ARGUMENT

True latitude argument.

MEAN_LATITUDE_ARGUMENT

public static final CircularCoordinate MEAN_LATITUDE_ARGUMENT

Mean latitude argument.

ECCENTRIC_LATITUDE_ARGUMENT

public static final CircularCoordinate ECCENTRIC_LATITUDE_ARGUMENT

Eccentric latitude argument.

Method Detail

values

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

Returns:

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

valueOf

public static CircularCoordinate 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 CircularCoordinate 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 latitude 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)