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