fr.cnes.sirius.patrius.propagation.precomputed

Class IntegratedEphemeris

java.lang.Object

fr.cnes.sirius.patrius.propagation.AbstractPropagator

fr.cnes.sirius.patrius.propagation.precomputed.IntegratedEphemeris

All Implemented Interfaces:

PVCoordinatesProvider, BoundedPropagator, Propagator, SpacecraftStateProvider, Serializable

public class IntegratedEphemeris
extends AbstractPropagator
implements BoundedPropagator

This class stores sequentially generated orbital parameters for later retrieval.

Instances of this class are built and then must be fed with the results provided by Propagator objects configured in ephemeris generation mode. Once propagation is o, random access to any intermediate state of the orbit throughout the propagation range is possible.

A typical use case is for numerically integrated orbits, which can be used by algorithms that need to wander around according to their own algorithm without cumbersome tight links with the integrator.

Another use case is for persistence, as this class is serializable.

As this class implements the Propagator interface, it can itself be used in batch mode to build another instance of the same type. This is however not recommended since it would be a waste of resources.

Note that this class stores all intermediate states along with interpolation models, so it may be memory intensive.

Author:

Mathieu Roméro, Luc Maisonobe, Véronique Pommier-Maurussane

See Also:

NumericalPropagator, Serialized Form

Field Summary

Fields inherited from class fr.cnes.sirius.patrius.propagation.AbstractPropagator

MASS

Fields inherited from interface fr.cnes.sirius.patrius.propagation.Propagator

EPHEMERIS_GENERATION_MODE, MASTER_MODE, SLAVE_MODE

Constructor Summary

Constructors

Constructor and Description
IntegratedEphemeris(List<AbsoluteDate> startDatesIn, List<AbsoluteDate> minDatesIn, List<AbsoluteDate> maxDatesIn, OrbitType orbitTypeIn, PositionAngle angleTypeIn, AttitudeProvider attitudeForcesProvider, AttitudeProvider attitudeEventsProvider, Map<String,AdditionalStateInfo> additionalStateInfos, List<ContinuousOutputModel> modelsIn, Frame referenceFrameIn, double muIn) Creates a new instance of IntegratedEphemeris.
IntegratedEphemeris(List<AbsoluteDate> startDatesIn, List<AbsoluteDate> minDatesIn, List<AbsoluteDate> maxDatesIn, OrbitType orbitTypeIn, PositionAngle angleTypeIn, AttitudeProvider attitudeProvider, Map<String,AdditionalStateInfo> additionalStateInfos, List<ContinuousOutputModel> modelsIn, Frame referenceFrameIn, double muIn) Creates a new instance of IntegratedEphemeris.

Method Summary

Modifier and Type	Method and Description
protected SpacecraftState	basicPropagate(AbsoluteDate date) Propagate an orbit without any fancy features.
SpacecraftState	getInitialState() Get the propagator initial state.
AbsoluteDate	getMaxDate() Get the last date of the range.
AbsoluteDate	getMinDate() Get the first date of the range.
PVCoordinates	getPVCoordinates(AbsoluteDate date, Frame frame) Default implementation for PVCoordinatesProvider feature using the SpacecraftState object's orbit.
SpacecraftState	getSpacecraftState(AbsoluteDate date) Get the SpacecraftState at provided date.
void	manageStateFrame() In this class, nothing as to be done in the frame managing before propagation because propagation will be performed in Frame referenceFrame It just throws an OrekitException if this frame is non inertial or pseudo-inertial.
protected Orbit	propagateOrbit(AbsoluteDate date) Extrapolate an orbit up to a specific target date.
void	resetInitialState(SpacecraftState state) Reset the propagator initial state.

Methods inherited from class fr.cnes.sirius.patrius.propagation.AbstractPropagator

acceptStep, addAdditionalStateProvider, addAdditionalStateProvider, addEventDetector, clearEventsDetectors, getAttitudeProvider, getAttitudeProviderEvents, getAttitudeProviderForces, getEventsDetectors, getFrame, getGeneratedEphemeris, getMode, getPvProvider, propagate, propagate, setAttitudeProvider, setAttitudeProviderEvents, setAttitudeProviderForces, setEphemerisMode, setMasterMode, setMasterMode, setOrbitFrame, setSlaveMode, setStartDate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface fr.cnes.sirius.patrius.propagation.BoundedPropagator

setOrbitFrame

Methods inherited from interface fr.cnes.sirius.patrius.propagation.Propagator

addEventDetector, clearEventsDetectors, getAttitudeProvider, getAttitudeProviderEvents, getAttitudeProviderForces, getEventsDetectors, getFrame, getGeneratedEphemeris, getMode, getNativeFrame, propagate, propagate, setAttitudeProvider, setAttitudeProviderEvents, setAttitudeProviderForces, setEphemerisMode, setMasterMode, setMasterMode, setSlaveMode

Constructor Detail

IntegratedEphemeris

public IntegratedEphemeris(List<AbsoluteDate> startDatesIn,
                           List<AbsoluteDate> minDatesIn,
                           List<AbsoluteDate> maxDatesIn,
                           OrbitType orbitTypeIn,
                           PositionAngle angleTypeIn,
                           AttitudeProvider attitudeProvider,
                           Map<String,AdditionalStateInfo> additionalStateInfos,
                           List<ContinuousOutputModel> modelsIn,
                           Frame referenceFrameIn,
                           double muIn)
                    throws PatriusException

Creates a new instance of IntegratedEphemeris.

Parameters:

startDatesIn - list of start dates of the integration (can be minDate or maxDate)

minDatesIn - list of first dates of the ranges

maxDatesIn - list of last dates of the ranges

orbitTypeIn - orbit type

angleTypeIn - position angle type

attitudeProvider - attitude provider in case of both forces and events computation

additionalStateInfos - additional states informations

modelsIn - list of underlying raw mathematical models

referenceFrameIn - reference referenceFrame

muIn - central body attraction coefficient

Throws:

PatriusException - if several providers have the same name

IntegratedEphemeris

public IntegratedEphemeris(List<AbsoluteDate> startDatesIn,
                           List<AbsoluteDate> minDatesIn,
                           List<AbsoluteDate> maxDatesIn,
                           OrbitType orbitTypeIn,
                           PositionAngle angleTypeIn,
                           AttitudeProvider attitudeForcesProvider,
                           AttitudeProvider attitudeEventsProvider,
                           Map<String,AdditionalStateInfo> additionalStateInfos,
                           List<ContinuousOutputModel> modelsIn,
                           Frame referenceFrameIn,
                           double muIn)
                    throws PatriusException

Creates a new instance of IntegratedEphemeris.

Parameters:

startDatesIn - list of start dates of the integration (can be minDate or maxDate)

minDatesIn - list of first dates of the ranges

maxDatesIn - list of last dates of the ranges

orbitTypeIn - orbit type

angleTypeIn - position angle type

attitudeForcesProvider - attitude provider for forces computation

attitudeEventsProvider - attitude provider for events computation

additionalStateInfos - additional states informations

modelsIn - list of underlying raw mathematical models

referenceFrameIn - reference referenceFrame

muIn - central body attraction coefficient

Throws:

PatriusException - if several providers have the same name

Method Detail

basicPropagate

protected SpacecraftState basicPropagate(AbsoluteDate date)
                                  throws PropagationException

Propagate an orbit without any fancy features.

This method is similar in spirit to the AbstractPropagator.propagate(fr.cnes.sirius.patrius.time.AbsoluteDate) method, except that it does not call any handler during propagation, nor any discrete events. It always stop exactly at the specified date.

Overrides:

basicPropagate in class AbstractPropagator

Parameters:

date - target date for propagation

Returns:

state at specified date

Throws:

PropagationException - if propagation cannot reach specified date

manageStateFrame

public void manageStateFrame()
                      throws PatriusException

In this class, nothing as to be done in the frame managing before propagation because propagation will be performed in Frame referenceFrame It just throws an OrekitException if this frame is non inertial or pseudo-inertial.

Overrides:

manageStateFrame in class AbstractPropagator

Throws:

PatriusException - if the frame is non inertial or pseudo-inertial

propagateOrbit

protected Orbit propagateOrbit(AbsoluteDate date)
                        throws PropagationException

Extrapolate an orbit up to a specific target date.

Specified by:

propagateOrbit in class AbstractPropagator

Parameters:

date - target date for the orbit

Returns:

extrapolated parameters

Throws:

PropagationException - if some parameters are out of bounds

getPVCoordinates

public PVCoordinates getPVCoordinates(AbsoluteDate date,
                                      Frame frame)
                               throws PatriusException

Default implementation for PVCoordinatesProvider feature using the SpacecraftState object's orbit.

Get the PVCoordinates of the body in the selected frame.

Specified by:

getPVCoordinates in interface PVCoordinatesProvider

Specified by:

getPVCoordinates in interface SpacecraftStateProvider

Overrides:

getPVCoordinates in class AbstractPropagator

Parameters:

date - current date

frame - the frame where to define the position

Returns:

position/velocity of the body (m and m/s)

Throws:

PatriusException - if position cannot be computed in given frame

getMinDate

public AbsoluteDate getMinDate()

Get the first date of the range.

Specified by:

getMinDate in interface BoundedPropagator

Returns:

the first date of the range

getMaxDate

public AbsoluteDate getMaxDate()

Get the last date of the range.

Specified by:

getMaxDate in interface BoundedPropagator

Returns:

the last date of the range

resetInitialState

public void resetInitialState(SpacecraftState state)
                       throws PropagationException

Reset the propagator initial state.

Specified by:

resetInitialState in interface Propagator

Overrides:

resetInitialState in class AbstractPropagator

Parameters:

state - new initial state to consider

Throws:

PropagationException - if initial state cannot be reset

getInitialState

public SpacecraftState getInitialState()
                                throws PatriusException

Get the propagator initial state.

Specified by:

getInitialState in interface Propagator

Overrides:

getInitialState in class AbstractPropagator

Returns:

initial state

Throws:

PatriusException - if state cannot be retrieved

getSpacecraftState

public SpacecraftState getSpacecraftState(AbsoluteDate date)
                                   throws PropagationException

Get the SpacecraftState at provided date.

Specified by:

getSpacecraftState in interface SpacecraftStateProvider

Overrides:

getSpacecraftState in class AbstractPropagator

Parameters:

date - target date

Returns:

spacecraft state

Throws:

PropagationException - if state cannot be computed