1   /* Copyright 2002-2021 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.List;
20  
21  import org.orekit.estimation.measurements.EstimationModifier;
22  import org.orekit.estimation.measurements.ObservedMeasurement;
23  import org.orekit.propagation.SpacecraftState;
24  import org.orekit.time.AbsoluteDate;
25  
26  
27  /** Interface for generating individual {@link ObservedMeasurement measurements}.
28   * @param <T> the type of the measurement
29   * @author Luc Maisonobe
30   * @since 9.3
31   */
32  public interface MeasurementBuilder<T extends ObservedMeasurement<T>> {
33  
34      /** Initialize builder at the start of a measurements generation.
35       * <p>
36       * This method is called once at the start of the measurements generation. It
37       * may be used by the builder to initialize some internal data
38       * if needed, typically setting up parameters reference dates.
39       * </p>
40       * @param start start of the measurements time span
41       * @param end end of the measurements time span
42       */
43      void init(AbsoluteDate start, AbsoluteDate end);
44  
45      /** Add a modifier.
46       * @param modifier modifier to add
47       */
48      void addModifier(EstimationModifier<T> modifier);
49  
50      /** Get the modifiers that apply to a measurement.
51       * @return modifiers that apply to a measurement
52       * @see #addModifier(EstimationModifier)
53       */
54      List<EstimationModifier<T>> getModifiers();
55  
56      /** Generate a single measurement.
57       * @param states all spacecraft states (i.e. including ones that may not be relevant for the current builder)
58       * @return generated measurement
59       */
60      T build(SpacecraftState[] states);
61  
62  }