org.orekit.propagation.sampling

Interface OrekitStepInterpolator

public interface OrekitStepInterpolator

This interface is a space-dynamics aware step interpolator.

It mirrors the ODEStateInterpolator interface from Hipparchus but provides a space-dynamics interface to the methods.

Author:

Luc Maisonobe

Method Summary

Modifier and Type	Method and Description
SpacecraftState	getCurrentState() Get the state at current grid point date.
SpacecraftState	getInterpolatedState(AbsoluteDate date) Get the state at interpolated date.
SpacecraftState	getPreviousState() Get the state at previous grid point date.
boolean	isCurrentStateInterpolated() Determines if the current state is computed directly by the integrator, or if it is calculated using interpolation.
boolean	isForward() Check is integration direction is forward in date.
boolean	isPreviousStateInterpolated() Determines if the previous state is computed directly by the integrator, or if it is calculated using interpolation.
OrekitStepInterpolator	restrictStep(SpacecraftState newPreviousState, SpacecraftState newCurrentState) Create a new restricted version of the instance.

Method Detail

getPreviousState

SpacecraftState getPreviousState()
                          throws OrekitException

Get the state at previous grid point date.

Returns:

state at previous grid point date

Throws:

OrekitException - if state cannot be retrieved

isPreviousStateInterpolated

boolean isPreviousStateInterpolated()

Determines if the previous state is computed directly by the integrator, or if it is calculated using interpolation.

Typically the previous state is directly computed by the integrator, but when events are detected the steps are shortened so that events occur on step boundaries which means the previous state may be computed by the interpolator.

Returns:

true if the previous state was calculated by the interpolator and false if it was computed directly by the integrator.

getCurrentState

SpacecraftState getCurrentState()
                         throws OrekitException

Get the state at current grid point date.

Returns:

state at current grid point date

Throws:

OrekitException - if state cannot be retrieved

isCurrentStateInterpolated

boolean isCurrentStateInterpolated()

Determines if the current state is computed directly by the integrator, or if it is calculated using interpolation.

Typically the current state is directly computed by the integrator, but when events are detected the steps are shortened so that events occur on step boundaries which means the current state may be computed by the interpolator.

Returns:

true if the current state was calculated by the interpolator and false if it was computed directly by the integrator.

getInterpolatedState

SpacecraftState getInterpolatedState(AbsoluteDate date)
                              throws OrekitException

Get the state at interpolated date.

Parameters:

date - date of the interpolated state

Returns:

state at interpolated date

Throws:

OrekitException - if underlying interpolator cannot handle the date

isForward

boolean isForward()

Check is integration direction is forward in date.

Returns:

true if integration is forward in date

restrictStep

OrekitStepInterpolator restrictStep(SpacecraftState newPreviousState,
                                    SpacecraftState newCurrentState)
                             throws OrekitException

Create a new restricted version of the instance.

The instance is not changed at all.

Parameters:

newPreviousState - start of the restricted step

newCurrentState - end of the restricted step

Returns:

restricted version of the instance

Throws:

OrekitException - if state cannot be converted

Since:

9.0

See Also:

getPreviousState(), getCurrentState()