1   /* Copyright 2022-2025 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  package org.orekit.propagation.events;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.orekit.propagation.FieldSpacecraftState;
21  
22  /** This interface represents an event enabling predicate function.
23   * @param <T> type of the field elements
24   * @author Luc Maisonobe
25   * @since 12.0
26   */
27  public interface FieldEnablingPredicate<T extends CalculusFieldElement<T>> {
28  
29      /** Compute an event enabling function of state.
30       * @param state current state
31       * @param detector underlying detector
32       * @param g value of the underlying detector for the current state
33       * @return true if the event is enabled (i.e. it can be
34       * triggered), false if it should be ignored
35       */
36      boolean eventIsEnabled(FieldSpacecraftState<T> state, FieldEventDetector<T> detector, T g);
37  
38  }