fr.cnes.sirius.patrius.orbits.orbitalparameters

Interface OrbitalCoordinate

All Known Implementing Classes:

AlternateEquinoctialCoordinate, ApsisAltitudeCoordinate, ApsisRadiusCoordinate, CartesianCoordinate, CircularCoordinate, EquatorialCoordinate, EquinoctialCoordinate, KeplerianCoordinate

public interface OrbitalCoordinate

Interface for classes listing the coordinates associated with a type of orbital parameters.

Author:

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

Method Summary

Modifier and Type	Method and Description
static void	checkStateVectorIndex(int stateVectorIndex) Static method to check if the state vector index is valid (between 0 and 5 (included)).
default OrbitalCoordinate	convertTo(OrbitType orbitType, PositionAngle positionAngle) Gets the coordinate type associated with the same state vector index in a given orbit type and position angle type.
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.

Method Detail

getOrbitType

OrbitType getOrbitType()

Gets the orbit type to which this orbital coordinate is related.

Returns:

the orbit type to which this orbital coordinate is related

getStateVectorIndex

int getStateVectorIndex()

Gets the index of the coordinate in the state vector array.

Returns:

the index of the coordinate in the state vector array.

convertTo

default OrbitalCoordinate convertTo(OrbitType orbitType,
                                    PositionAngle positionAngle)

Gets the coordinate type associated with the same state vector index in a given orbit type and position angle type.

Parameters:

orbitType - the target orbit type

positionAngle - the target position angle type

Returns:

the coordinate type associated with the same state vector index in the specified orbit and position angle types

checkStateVectorIndex

static void checkStateVectorIndex(int stateVectorIndex)

Static method to check if the state vector index is valid (between 0 and 5 (included)).

Parameters:

stateVectorIndex - the state vector index

Throws:

IllegalArgumentException - if the provided state vector index is not between 0 and 5 (included)