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