Package org.orekit.propagation.sampling

Interface OrekitFixedStepHandler

All Known Implementing Classes:

StreamingOemWriter.Segment

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface OrekitFixedStepHandler

This interface is a space-dynamics aware fixed size step handler.

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

Author:

Luc Maisonobe

Method Summary

Modifier and Type	Method	Description
void	handleStep(SpacecraftState currentState, boolean isLast)	Handle the current step.
default void	init(SpacecraftState s0, AbsoluteDate t)	Deprecated. as of 9.0, replaced by init(SpacecraftState, AbsoluteDate, double)
default void	init(SpacecraftState s0, AbsoluteDate t, double step)	Initialize step handler at the start of a propagation.

Method Detail

init

@Deprecated
default void init(SpacecraftState s0,
                  AbsoluteDate t)
           throws OrekitException

Deprecated. as of 9.0, replaced by init(SpacecraftState, AbsoluteDate, double)

Initialize step handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the step handler to initialize some internal data if needed.

The default implementation does nothing

Parameters:

s0 - initial state

t - target time for the integration

Throws:

OrekitException - if step handler cannot be initialized

init

default void init(SpacecraftState s0,
                  AbsoluteDate t,
                  double step)
           throws OrekitException

Initialize step handler at the start of a propagation.

This method is called once at the start of the propagation. It may be used by the step handler to initialize some internal data if needed.

The default implementation currently calls the deprecated init(SpacecraftState, AbsoluteDate) which does nothing by default. When that method is removed the default implementation will do nothing.

Parameters:

s0 - initial state

t - target time for the integration

step - the duration in seconds of the fixed step. This value is positive even if propagation is backwards.

Throws:

OrekitException - if step handler cannot be initialized

Since:

9.0

handleStep

void handleStep(SpacecraftState currentState,
                boolean isLast)
         throws OrekitException

Handle the current step.

Parameters:

currentState - current state at step time

isLast - if true, this is the last integration step

Throws:

OrekitException - if step cannot be handled