fr.cnes.sirius.patrius.orbits

Enum OrbitType

java.lang.Object

java.lang.Enum<OrbitType>

fr.cnes.sirius.patrius.orbits.OrbitType

All Implemented Interfaces:

Serializable, Comparable<OrbitType>

public enum OrbitType
extends Enum<OrbitType>

Enumerate for orbital parameters types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALTERNATE_EQUINOCTIAL Type for propagation in Alternate equinoctial parameters.
APSIS Type for propagation in Apsis parameters.
CARTESIAN Type for propagation in Cartesian parameters.
CIRCULAR Type for propagation in circular parameters.
EQUATORIAL Type for propagation in Equatorial parameters.
EQUINOCTIAL Type for propagation in equinoctial parameters.
KEPLERIAN Type for propagation in Keplerian parameters.

Method Summary

Modifier and Type	Method and Description
abstract Orbit	convertOrbit(Orbit initOrbit, Frame frame) Convert an orbit from a given orbit type to an other in a wished frame.
abstract Orbit	convertType(Orbit orbit) Convert an orbit to the instance type.
abstract OrbitalCoordinate	getCoordinateType(int stateVectorIndex, PositionAngle positionAngle) Gets the coordinate type associated with a given state vector index.
abstract Orbit	mapArrayToOrbit(double[] array, PositionAngle type, AbsoluteDate date, double mu, Frame frame) Convert state array to orbital parameters.
abstract void	mapOrbitToArray(Orbit orbit, PositionAngle type, double[] stateVector) Convert orbit to state array.
static OrbitType	valueOf(String name) Returns the enum constant of this type with the specified name.
static OrbitType[]	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

Enum Constant Detail

CARTESIAN

public static final OrbitType CARTESIAN

Type for propagation in Cartesian parameters.

CIRCULAR

public static final OrbitType CIRCULAR

Type for propagation in circular parameters.

EQUINOCTIAL

public static final OrbitType EQUINOCTIAL

Type for propagation in equinoctial parameters.

ALTERNATE_EQUINOCTIAL

public static final OrbitType ALTERNATE_EQUINOCTIAL

Type for propagation in Alternate equinoctial parameters.

APSIS

public static final OrbitType APSIS

Type for propagation in Apsis parameters.

EQUATORIAL

public static final OrbitType EQUATORIAL

Type for propagation in Equatorial parameters.

KEPLERIAN

public static final OrbitType KEPLERIAN

Type for propagation in Keplerian parameters.

Method Detail

values

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

Returns:

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

valueOf

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

convertType

public abstract Orbit convertType(Orbit orbit)

Convert an orbit to the instance type.

The returned orbit is the specified instance itself if its type already matches, otherwise a new orbit of the proper type created

Parameters:

orbit - orbit to convert

Returns:

converted orbit with type guaranteed to match (so it can be cast safely)

mapOrbitToArray

public abstract void mapOrbitToArray(Orbit orbit,
                                     PositionAngle type,
                                     double[] stateVector)

Convert orbit to state array.

Note that all implementations of this method must be consistent with the implementation of the Orbit.getJacobianWrtCartesian method for the corresponding orbit type in terms of parameters order and meaning.

Parameters:

orbit - orbit to map

type - type of the angle

stateVector - flat array into which the state vector should be mapped

mapArrayToOrbit

public abstract Orbit mapArrayToOrbit(double[] array,
                                      PositionAngle type,
                                      AbsoluteDate date,
                                      double mu,
                                      Frame frame)

Convert state array to orbital parameters.

Note that all implementations of this method must be consistent with the implementation of the Orbit.getJacobianWrtCartesian method for the corresponding orbit type in terms of parameters order and meaning.

Parameters:

array - state as a flat array

type - type of the angle

date - integration date

mu - central attraction coefficient used for propagation (m³/s²)

frame - frame in which integration is performed

Returns:

orbit corresponding to the flat array as a space dynamics object

convertOrbit

public abstract Orbit convertOrbit(Orbit initOrbit,
                                   Frame frame)
                            throws PatriusException

Convert an orbit from a given orbit type to an other in a wished frame.

Parameters:

initOrbit - the input orbit

frame - the frame where the input orbit is converted it is not necessary inertial or pseudo-inertial

Returns:

the converted orbit

Throws:

PatriusException - if transformation between frames cannot be computed

getCoordinateType

public abstract OrbitalCoordinate getCoordinateType(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

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)