1   /* Copyright 2022-2025 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.events.handlers.FieldEventHandler;
22  
23  /** Abstract class for detectors using a topocentric frame.
24   *
25   * @author Romain Serra
26   * @since 13.1
27   * @see AbstractTopocentricDetector
28   * @see TopocentricFrame
29   */
30  public abstract class FieldAbstractTopocentricDetector<D extends FieldAbstractDetector<D, T>, T extends CalculusFieldElement<T>>
31          extends FieldAbstractDetector<D, T> {
32  
33      /** Reference topocentric frame. */
34      private final TopocentricFrame topocentricFrame;
35  
36      /** Protected constructor with full parameters.
37       * @param detectionSettings event detection settings
38       * @param handler event handler to call at event occurrences
39       * @param topocentricFrame topocentric frame
40       */
41      protected FieldAbstractTopocentricDetector(final FieldEventDetectionSettings<T> detectionSettings, final FieldEventHandler<T> handler,
42                                                 final TopocentricFrame topocentricFrame) {
43          super(detectionSettings, handler);
44          this.topocentricFrame = topocentricFrame;
45      }
46  
47      /**
48       * Getter for the topocentric frame.
49       * @return frame
50       */
51      public TopocentricFrame getTopocentricFrame() {
52          return topocentricFrame;
53      }
54  
55  }