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  
19  import org.hipparchus.ode.events.Action;
20  import org.orekit.propagation.SpacecraftState;
21  import org.orekit.propagation.events.EventDetector;
22  
23  /**
24   * Abstract class for handlers counting event occurrences. The {@link Action} can be modified according to the count.
25   * @author Romain Serra
26   * @since 13.0
27   */
28  public abstract class CountingHandler extends AbstractGenericCountingHandler implements EventHandler {
29  
30      /**
31       * Constructor.
32       *
33       * @param startingCount value to initialize count
34       * @param action        Action to initialize attribute
35       */
36      protected CountingHandler(final int startingCount, final Action action) {
37          super(startingCount, action);
38      }
39  
40      /** {@inheritDoc} */
41      @Override
42      public Action eventOccurred(final SpacecraftState s, final EventDetector detector, final boolean increasing) {
43          if (doesCount(s, detector, increasing)) {
44              increment();
45          }
46          return getAction();
47      }
48  
49      /**
50       * Method returning true if and only if the count needs to be incremented.
51       * @param state state at detection
52       * @param detector detector
53       * @param increasing flag on direction of event function
54       * @return flag on counting
55       */
56      protected abstract boolean doesCount(SpacecraftState state, EventDetector detector, boolean increasing);
57  }