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  
21  /**
22   * Abstract, Orekit-internal class for standard and fielded handlers counting event occurrences.
23   * The {@link Action} can be modified according to the count.
24   * @author Romain Serra
25   * @since 13.0
26   */
27  abstract class AbstractGenericCountingHandler {
28  
29      /** Action to return. */
30      private Action action;
31  
32      /** Number of event occurrences. */
33      private int count;
34  
35      /** Constructor.
36       * @param startingCount value to initialize count
37       * @param action Action to initialize attribute
38       */
39      protected AbstractGenericCountingHandler(final int startingCount, final Action action) {
40          this.count = startingCount;
41          this.action = action;
42      }
43  
44      /**
45       * Getter for count.
46       * @return count
47       */
48      public int getCount() {
49          return count;
50      }
51  
52      /**
53       * Protected getter for the action to return.
54       * @return action
55       */
56      protected Action getAction() {
57          return action;
58      }
59  
60      /**
61       * Protected setter for action.
62       * @param action new action
63       */
64      protected void setAction(final Action action) {
65          this.action = action;
66      }
67  
68      /**
69       * Reset count.
70       */
71      public void reset() {
72          count = 0;
73      }
74  
75      /**
76       * Increment count.
77       */
78      protected void increment() {
79          count++;
80      }
81  }