ResetDerivativesOnEvent.java

  1. /* Copyright 2022-2025 Romain Serra
  2.  * Licensed to CS GROUP (CS) under one or more
  3.  * contributor license agreements.  See the NOTICE file distributed with
  4.  * this work for additional information regarding copyright ownership.
  5.  * CS licenses this file to You under the Apache License, Version 2.0
  6.  * (the "License"); you may not use this file except in compliance with
  7.  * the License.  You may obtain a copy of the License at
  8.  *
  9.  *   http://www.apache.org/licenses/LICENSE-2.0
  10.  *
  11.  * Unless required by applicable law or agreed to in writing, software
  12.  * distributed under the License is distributed on an "AS IS" BASIS,
  13.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14.  * See the License for the specific language governing permissions and
  15.  * limitations under the License.
  16.  */
  17. package org.orekit.propagation.events.handlers;

  18. import org.hipparchus.ode.events.Action;
  19. import org.orekit.propagation.SpacecraftState;
  20. import org.orekit.propagation.events.EventDetector;

  21. /**
  22.  * Event handler which will always return {@link Action#RESET_DERIVATIVES stop} as a state.
  23.  *
  24.  * @author Romain Serra
  25.  *
  26.  * @since 12.2
  27.  */
  28. public class ResetDerivativesOnEvent implements EventHandler {

  29.     /**
  30.      * Specific implementation of the eventOccurred interface.
  31.      *
  32.      * @param s SpaceCraft state to be used in the evaluation
  33.      * @param detector object with appropriate type that can be used in determining correct return state
  34.      * @param increasing with the event occurred in an "increasing" or "decreasing" slope direction
  35.      * @return {@link Action#RESET_DERIVATIVES stop} under all circumstances
  36.      */
  37.     @Override
  38.     public Action eventOccurred(final SpacecraftState s, final EventDetector detector, final boolean increasing) {
  39.         return Action.RESET_DERIVATIVES;
  40.     }

  41. }