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