fr.cnes.sirius.patrius.propagation.sampling

Interface PatriusStepInterpolator

All Superinterfaces:

Serializable

All Known Implementing Classes:

AdaptedStepHandler, BasicStepInterpolator, StelaBasicInterpolator

public interface PatriusStepInterpolator
extends Serializable

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.

Author:

Luc Maisonobe

Method Summary

Modifier and Type	Method and Description
AbsoluteDate	getCurrentDate() Get the current grid date.
AbsoluteDate	getInterpolatedDate() Get the interpolated date.
SpacecraftState	getInterpolatedState() Get the interpolated state.
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), getInterpolatedState()

setInterpolatedDate

void setInterpolatedDate(AbsoluteDate date)
                  throws PropagationException,
                         PatriusException

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

PatriusException - if attitude cannot be computed

See Also:

getInterpolatedDate(), getInterpolatedState()

getInterpolatedState

SpacecraftState getInterpolatedState()
                              throws PatriusException

Get the interpolated state.

Returns:

interpolated state at the current interpolation date

Throws:

PatriusException - if 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