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.sampling;
18  
19  import org.orekit.propagation.SpacecraftState;
20  import org.orekit.time.AbsoluteDate;
21  
22  import java.util.ArrayList;
23  import java.util.List;
24  
25  /**
26   * Step handler recording states.
27   * Automatically clears them at start of propagation.
28   *
29   * @author Romain Serra
30   * @since 13.0
31   */
32  public class PropagationStepRecorder implements OrekitStepHandler {
33  
34      /** Flag to reset or not on (re)initialization. */
35      private boolean resetAutomatically;
36  
37      /**
38       * Recorded times.
39       */
40      private final List<SpacecraftState> states;
41  
42      /**
43       * Constructor.
44       * @param resetAutomatically resetting flag
45       * @since 13.1
46       */
47      public PropagationStepRecorder(final boolean resetAutomatically) {
48          this.resetAutomatically  = resetAutomatically;
49          this.states = new ArrayList<>();
50      }
51  
52      /**
53       * Constructor with default flag.
54       */
55      public PropagationStepRecorder() {
56          this(true);
57      }
58  
59      /**
60       * Setter for resetting flag.
61       * @param resetAutomatically flag
62       * @since 13.1
63       */
64      public void setResetAutomatically(final boolean resetAutomatically) {
65          this.resetAutomatically = resetAutomatically;
66      }
67  
68      /**
69       * Getter for resetting flag.
70       * @return flag
71       * @since 13.1
72       */
73      public boolean isResetAutomatically() {
74          return resetAutomatically;
75      }
76  
77      /**
78       * Copy the current saved steps.
79       * @return copy of steps
80       */
81      public List<SpacecraftState> copyStates() {
82          return new ArrayList<>(states);
83      }
84  
85      /** {@inheritDoc} */
86      @Override
87      public void init(final SpacecraftState s0, final AbsoluteDate t) {
88          OrekitStepHandler.super.init(s0, t);
89          if (resetAutomatically) {
90              states.clear();
91          }
92      }
93  
94      /** {@inheritDoc} */
95      @Override
96      public void handleStep(final OrekitStepInterpolator interpolator) {
97          states.add(interpolator.getCurrentState());
98      }
99  }