1   /* Copyright 2002-2024 Luc Maisonobe
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  
18  package org.orekit.propagation.events;
19  
20  import org.hipparchus.CalculusFieldElement;
21  import org.orekit.propagation.FieldSpacecraftState;
22  
23  /** This interface represents an event checking interval that depends on state.
24  *
25  * @see FieldEventDetector
26  * @author Luc Maisonobe
27  * @since 12.0
28  * @param <T> the type of the field elements
29  */
30  @FunctionalInterface
31  public interface FieldAdaptableInterval<T extends CalculusFieldElement<T>> {
32  
33      /** Get the current value of maximal time interval between events handler checks.
34       * @param state current state
35       * @return current value of maximal time interval between events handler checks (only as a double)
36       */
37      double currentInterval(FieldSpacecraftState<T> state);
38  
39      /**
40       * Method creating a constant interval provider.
41       * @param <T> field type
42       * @param constantInterval value of constant interval
43       * @return adaptable interval ready to be added to an event detector
44       * @since 12.1
45       */
46      static <T extends CalculusFieldElement<T>> FieldAdaptableInterval<T> of(final double constantInterval) {
47          return state -> constantInterval;
48      }
49  }