fr.cnes.sirius.patrius.propagation.sampling.multi
Interface MultiOrekitStepInterpolator

All Known Implementing Classes:

MultiAdaptedStepHandler

public interface MultiOrekitStepInterpolator

This interface is copied from OrekitStepInterpolator and adapted to multi propagation.

This interface is a space-dynamics aware step interpolator.

It mirrors the StepInterpolator interface from commons-math but provides a space-dynamics interface to the methods.

Since:

3.0

Version:

$Id: MultiOrekitStepInterpolator.java 17585 2017-05-10 13:27:59Z bignon $

Author:

maggioranic

Method Summary

AbsoluteDate	getCurrentDate() Get the current grid date.
AbsoluteDate	getInterpolatedDate() Get the interpolated date.
Map<String,SpacecraftState>	getInterpolatedStates() Get all the interpolated states.
AbsoluteDate	getPreviousDate() Get the previous grid date.
boolean	isForward() Check is integration direction is forward in date.
void	setInterpolatedDate(AbsoluteDate date) Set the interpolated date.

Method Detail

getCurrentDate

AbsoluteDate getCurrentDate()

Get the current grid date.

Returns:

current grid date

getPreviousDate

AbsoluteDate getPreviousDate()

Get the previous grid date.

Returns:

previous grid date

getInterpolatedDate

AbsoluteDate getInterpolatedDate()

Get the interpolated date.

If setInterpolatedDate has not been called, the date returned is the same as getCurrentDate.

Returns:

interpolated date

See Also:

setInterpolatedDate(AbsoluteDate), getInterpolatedStates()

setInterpolatedDate

void setInterpolatedDate(AbsoluteDate date)
                         throws PropagationException

Set the interpolated date.

It is possible to set the interpolation date outside of the current step range, but accuracy will decrease as date is farther.

Parameters:

date - interpolated date to set

Throws:

PropagationException - if underlying interpolator cannot handle the date

See Also:

getInterpolatedDate(), getInterpolatedStates()

getInterpolatedStates

Map<String,SpacecraftState> getInterpolatedStates()
                                                  throws OrekitException

Get all the interpolated states.

Returns:

interpolated states at the current interpolation date

Throws:

OrekitException - if a state cannot be interpolated or converted

See Also:

getInterpolatedDate(), setInterpolatedDate(AbsoluteDate)

isForward

boolean isForward()

Check is integration direction is forward in date.

Returns:

true if integration is forward in date