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.orekit.propagation.SpacecraftState;
21  
22  /** This interface represents an event checking interval that depends on state.
23  *
24  * @see EventDetector
25  * @author Luc Maisonobe
26  * @since 12.0
27  *
28  */
29  @FunctionalInterface
30  public interface AdaptableInterval {
31  
32      /** Get the current value of maximal time interval between events handler checks.
33       * @param state current state
34       * @return current value of maximal time interval between events handler checks
35       */
36      double currentInterval(SpacecraftState state);
37  
38      /**
39       * Method creating a constant interval provider.
40       * @param constantInterval value of constant interval
41       * @return adaptable interval ready to be added to an event detector
42       * @since 12.1
43       */
44      static AdaptableInterval of(final double constantInterval) {
45          return state -> constantInterval;
46      }
47  }