1   /* Copyright 2013 Applied Defense Solutions, Inc.
2    * Licensed to CS Communication & Systèmes (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  
19  import org.hipparchus.ode.events.Action;
20  import org.orekit.propagation.SpacecraftState;
21  import org.orekit.propagation.events.EventDetector;
22  
23  /**
24   * Event handler which will always return {@link Action#STOP stop} as a state.
25   *
26   * @author Hank Grabowski
27   *
28   * @since 6.1
29   */
30  public class StopOnEvent implements EventHandler {
31  
32      /** Empty constructor.
33       * <p>
34       * This constructor is not strictly necessary, but it prevents spurious
35       * javadoc warnings with JDK 18 and later.
36       * </p>
37       * @since 12.0
38       */
39      public StopOnEvent() {
40          // nothing to do
41      }
42  
43      /**
44       * Specific implementation of the eventOccurred interface.
45       *
46       * @param s SpaceCraft state to be used in the evaluation
47       * @param detector object with appropriate type that can be used in determining correct return state
48       * @param increasing with the event occurred in an "increasing" or "decreasing" slope direction
49       * @return {@link Action#STOP stop} under all circumstances
50       */
51      @Override
52      public Action eventOccurred(final SpacecraftState s, final EventDetector detector, final boolean increasing) {
53          return Action.STOP;
54      }
55  
56  }