OrekitFixedStepHandler.java
/* Copyright 2002-2019 CS Systèmes d'Information
* Licensed to CS Systèmes d'Information (CS) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* CS licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.orekit.propagation.sampling;
import org.orekit.propagation.SpacecraftState;
import org.orekit.time.AbsoluteDate;
/** This interface is a space-dynamics aware fixed size step handler.
*
* <p>It mirrors the <code>FixedStepHandler</code> interface from <a
* href="https://hipparchus.org/">Hipparchus</a> but provides
* a space-dynamics interface to the methods.</p>
* @author Luc Maisonobe
*/
@FunctionalInterface
public interface OrekitFixedStepHandler {
/** Initialize step handler at the start of a propagation.
* <p>
* 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.
* </p>
* <p>
* The default implementation does nothing
* </p>
* @param s0 initial state
* @param t target time for the integration
* @deprecated as of 9.0, replaced by {@link #init(SpacecraftState, AbsoluteDate, double)}
*/
@Deprecated
default void init(SpacecraftState s0, AbsoluteDate t) {
// nothing by default
}
/** Initialize step handler at the start of a propagation.
* <p>
* 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.
* </p>
* <p>
* The default implementation currently calls the deprecated
* {@link #init(SpacecraftState, AbsoluteDate)} which does nothing by
* default. When that method is removed the default implementation will do
* nothing.
* </p>
* @param s0 initial state
* @param t target time for the integration
* @param step the duration in seconds of the fixed step. This value is
* positive even if propagation is backwards.
* @since 9.0
*/
default void init(SpacecraftState s0, AbsoluteDate t, double step) {
// as of 9.0, the default implementation calls the DEPRECATED version
// without a step size, which does nothing by default but may have
// been overridden by users
// When the deprecated version is removed, the default implementation
// will do nothing
init(s0, t);
}
/** Handle the current step.
* @param currentState current state at step time
* @param isLast if true, this is the last integration step
*/
void handleStep(SpacecraftState currentState, boolean isLast);
}