1   /* Copyright 2022-2025 Thales Alenia Space
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;
18  
19  /** Abstract base class for modifying state during propagation.
20   * <p>
21   * This class is a specialized implementation of {@link AdditionalDataProvider}
22   * with a name set to the empty string and returning a null additional state.
23   * </p>
24   * <p>
25   * Beware that changing the state undercover from the propagator may have
26   * many side effects. Using this class should therefore be done cautiously.
27   * </p>
28   * @see Propagator
29   * @see AdditionalDataProvider
30   * @author Luc Maisonobe
31   * @since 12.1
32   */
33  public abstract class AbstractStateModifier implements AdditionalDataProvider<double[]> {
34  
35      /** {@inheritDoc} */
36      @Override
37      public String getName() {
38          return "";
39      }
40  
41      /** {@inheritDoc} */
42      @Override
43      public double[] getAdditionalData(final SpacecraftState state) {
44          return null;
45      }
46  
47      /** {@inheritDoc} */
48      @Override
49      public SpacecraftState update(final SpacecraftState state) {
50          return change(state);
51      }
52  
53      /** Change main state.
54       * @param state spacecraft state to change
55       * @return changed state
56       */
57      public abstract SpacecraftState change(SpacecraftState state);
58  
59  }