FieldManeuverTriggersResetter.java

/* Copyright 2002-2024 CS GROUP
 * Licensed to CS GROUP (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.forces.maneuvers.trigger;

import org.hipparchus.CalculusFieldElement;
import org.orekit.propagation.FieldSpacecraftState;
import org.orekit.time.FieldAbsoluteDate;

/** Resetter for maneuver triggers.
 * @param <T> type of the field elements
 * @see AbstractManeuverTriggers
 * @author Luc Maisonobe
 * @since 11.1
 */
public interface FieldManeuverTriggersResetter<T extends CalculusFieldElement<T>> {

    /** Initialization method called at propagation start.
     * <p>
     * The default implementation does nothing.
     * </p>
     * @param initialState initial spacecraft state (at the start of propagation).
     * @param target date of propagation. Not equal to {@code initialState.getDate()}.
     */
    default void init(FieldSpacecraftState<T> initialState, FieldAbsoluteDate<T> target) {
        // nothing by default
    }

    /** Observe a maneuver trigger.
     * <p>
     * The {@code start} parameter corresponds to physical flow of time
     * from past to future, not to propagation direction which can be backward.
     * This means that during forward propagations, the first call will have
     * {@code start} set to {@code true} and the second call will have
     * {@code start} set to {@code false}, whereas in backward propagation,
     * the first call will have {@code start} set to {@code false} and the second
     * call will have {@code start} set to {@code true}.
     * </p>
     * @param state spacecraft state at trigger date (before applying the maneuver)
     * @param start if true, the trigger is the start of the maneuver
     */
    void maneuverTriggered(FieldSpacecraftState<T> state, boolean start);

    /** Reset state as a maneuver triggers.
     * @param state spacecraft state at trigger date
     * @return reset state taking into account maneuver start/stop
     */
    FieldSpacecraftState<T> resetState(FieldSpacecraftState<T> state);

}