1   /* Copyright 2022-2026 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.events;
18  
19  import org.hipparchus.CalculusFieldElement;
20  import org.orekit.frames.TopocentricFrame;
21  import org.orekit.propagation.FieldSpacecraftState;
22  import org.orekit.propagation.events.functions.EventFunction;
23  import org.orekit.propagation.events.handlers.FieldEventHandler;
24  
25  /** Abstract class for detectors using a topocentric frame.
26   *
27   * @param <D> type of the detector
28   * @param <T> type of the field elements
29   * @author Romain Serra
30   * @since 13.1
31   * @see AbstractTopocentricDetector
32   * @see TopocentricFrame
33   */
34  public abstract class FieldAbstractTopocentricDetector<D extends FieldAbstractDetector<D, T>, T extends CalculusFieldElement<T>>
35          extends FieldAbstractDetector<D, T> {
36  
37      /** Reference topocentric frame. */
38      private final TopocentricFrame topocentricFrame;
39  
40      /** Protected constructor with full parameters.
41       * @param eventFunction event function
42       * @param detectionSettings event detection settings
43       * @param handler event handler to call at event occurrences
44       * @param topocentricFrame topocentric frame
45       * @since 14.0
46       */
47      protected FieldAbstractTopocentricDetector(final EventFunction eventFunction,
48                                                 final FieldEventDetectionSettings<T> detectionSettings,
49                                                 final FieldEventHandler<T> handler,
50                                                 final TopocentricFrame topocentricFrame) {
51          super(eventFunction, detectionSettings, handler);
52          this.topocentricFrame = topocentricFrame;
53      }
54  
55      /**
56       * Getter for the topocentric frame.
57       * @return frame
58       */
59      public TopocentricFrame getTopocentricFrame() {
60          return topocentricFrame;
61      }
62  
63  
64      /** Get the elevation value.
65       * @param s the current state information: date, kinematics, attitude
66       * @return spacecraft elevation
67       */
68      public T getElevation(final FieldSpacecraftState<T> s) {
69          return getTopocentricFrame().getElevation(s.getPosition(), s.getFrame(), s.getDate());
70      }
71  }