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  
18  package org.orekit.propagation.events.handlers;
19  
20  
21  import org.hipparchus.CalculusFieldElement;
22  import org.hipparchus.ode.events.Action;
23  import org.orekit.propagation.FieldSpacecraftState;
24  import org.orekit.propagation.events.FieldEventDetector;
25  
26  
27  /**
28   * Event handler which will always return {@link Action#CONTINUE continue} as a state.
29   * @author Hank Grabowski
30   *
31   * @param <T> type of the field element
32   */
33  public class FieldStopOnEvent <T extends CalculusFieldElement<T>> implements FieldEventHandler<T> {
34  
35      /** Empty constructor.
36       * <p>
37       * This constructor is not strictly necessary, but it prevents spurious
38       * javadoc warnings with JDK 18 and later.
39       * </p>
40       * @since 12.0
41       */
42      public FieldStopOnEvent() {
43          // nothing to do
44      }
45  
46      /**
47       * Specific implementation of the eventOccurred interface.
48       *
49       * @param s SpaceCraft state to be used in the evaluation
50       * @param detector object with appropriate type that can be used in determining correct return state
51       * @param increasing with the event occurred in an "increasing" or "decreasing" slope direction
52       * @return {@link Action#STOP stop} under all circumstances
53       */
54      @Override
55      public Action eventOccurred(final FieldSpacecraftState<T> s, final FieldEventDetector<T> detector, final boolean increasing) {
56          return Action.STOP;
57      }
58  
59  }