FieldStopOnIncreasing.java

  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. import org.hipparchus.CalculusFieldElement;
  19. import org.hipparchus.ode.events.Action;
  20. import org.orekit.propagation.FieldSpacecraftState;
  21. import org.orekit.propagation.events.FieldEventDetector;


  22. /** Handle a detection event and choose what to do next.
  23.  * <p>The implementation behavior is to {@link
  24.  * Action#CONTINUE continue} propagation when descending and to
  25.  * {@link Action#STOP stop} propagation when ascending.</p>
  26.  *
  27.  * @author Hank Grabowski
  28.  *
  29.  * @param <T> type of the field element
  30.  */
  31. public class FieldStopOnIncreasing <T extends CalculusFieldElement<T>> implements FieldEventHandler<T> {

  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 FieldStopOnIncreasing() {
  40.         // nothing to do
  41.     }

  42.     /** Handle a detection event and choose what to do next.
  43.      * <p>The implementation behavior is to {@link
  44.      * Action#CONTINUE continue} propagation when descending and to
  45.      * {@link Action#STOP stop} propagation when ascending.</p>
  46.      * @param s the current state information : date, kinematics, attitude
  47.      * @param detector the detector object calling this method (not used in the evaluation)
  48.      * @param increasing if true, the value of the switching function increases
  49.      * when times increases around event
  50.      * @return {@link Action#STOP} or {@link Action#CONTINUE}
  51.      */
  52.     @Override
  53.     public Action eventOccurred(final FieldSpacecraftState<T> s, final FieldEventDetector<T> detector, final boolean increasing) {
  54.         return increasing ? Action.STOP : Action.CONTINUE;
  55.     }

  56. }