1   /* Copyright 2002-2024 CS GROUP
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.estimation.measurements.generation;
18  
19  import java.util.Map;
20  import java.util.SortedSet;
21  
22  import org.orekit.estimation.measurements.ObservableSatellite;
23  import org.orekit.estimation.measurements.ObservedMeasurement;
24  import org.orekit.propagation.sampling.OrekitStepInterpolator;
25  import org.orekit.time.AbsoluteDate;
26  
27  
28  /** Interface for generating {@link ObservedMeasurement measurements} sequences.
29   * @param <T> the type of the measurement
30   * @author Luc Maisonobe
31   * @since 9.3
32   */
33  public interface Scheduler<T extends ObservedMeasurement<T>> {
34  
35      /** Get the builder associated with this scheduler.
36       * @return builder associated with this scheduler
37       * @since 12.0
38       */
39      MeasurementBuilder<T> getBuilder();
40  
41      /** Initialize scheduler at the start of a measurements generation.
42       * <p>
43       * This method is called once at the start of the measurements generation. It
44       * may be used by the scheduler to initialize some internal data
45       * if needed, typically {@link MeasurementBuilder#init(AbsoluteDate, AbsoluteDate)
46       * initializing builders}.
47       * </p>
48       * @param start start of the measurements time span
49       * @param end end of the measurements time span
50       */
51      void init(AbsoluteDate start, AbsoluteDate end);
52  
53      /** Generate a sequence of measurements.
54       * @param interpolators interpolators for spacecraft states
55       * @return generated measurements
56       * @since 12.0
57       */
58      SortedSet<T> generate(Map<ObservableSatellite, OrekitStepInterpolator> interpolators);
59  
60  }