fr.cnes.sirius.patrius.orbits.orbitalparameters

Enum CartesianCoordinate

java.lang.Object

java.lang.Enum<CartesianCoordinate>

fr.cnes.sirius.patrius.orbits.orbitalparameters.CartesianCoordinate

All Implemented Interfaces:

OrbitalCoordinate, Serializable, Comparable<CartesianCoordinate>

public enum CartesianCoordinate
extends Enum<CartesianCoordinate>
implements OrbitalCoordinate

Enumerates the different coordinates associated with the cartesian parameters.

Author:

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
VX First component of the velocity vector.
VY Second component of the velocity vector.
VZ Third component of the velocity vector.
X First component of the position vector.
Y Second component of the position vector.
Z Third component of the position vector.

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

X

public static final CartesianCoordinate X

First component of the position vector.

Y

public static final CartesianCoordinate Y

Second component of the position vector.

Z

public static final CartesianCoordinate Z

Third component of the position vector.

VX

public static final CartesianCoordinate VX

First component of the velocity vector.

VY

public static final CartesianCoordinate VY

Second component of the velocity vector.

VZ

public static final CartesianCoordinate VZ

Third component of the velocity vector.

Method Detail

values

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

Returns:

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

valueOf

public static CartesianCoordinate 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 CartesianCoordinate valueOf(int stateVectorIndex)

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

Parameters:

stateVectorIndex - the state vector index

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)