1   /* Copyright 2002-2017 CS Systèmes d'Information
2    * Licensed to CS Systèmes d'Information (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.semianalytical.dsst.forces;
18  
19  import java.io.Serializable;
20  import java.util.Map;
21  import java.util.Set;
22  
23  import org.orekit.errors.OrekitException;
24  import org.orekit.orbits.Orbit;
25  import org.orekit.time.AbsoluteDate;
26  
27  /** Additive short period terms contributing to the mean to osculating orbit mapping.
28   * <p>
29   * Each instance contains a set of several terms that are computed together.
30   * </p>
31   * @see DSSTForceModel
32   * @author Luc Maisonobe
33   * @since 7.1
34   */
35  public interface ShortPeriodTerms extends Serializable {
36  
37      /** Evaluate the contributions of the short period terms.
38       * @param meanOrbit mean orbit to which the short period contribution applies
39       * @return short period terms contributions
40       * @exception OrekitException if short period terms cannot be computed
41       */
42      double[] value(Orbit meanOrbit) throws OrekitException;
43  
44      /** Get the prefix for short period coefficients keys.
45       * <p>
46       * This prefix is used to identify the coefficients of the
47       * current force model from the coefficients pertaining to
48       * other force models. All the keys in the map returned by
49       * {@link #getCoefficients(AbsoluteDate, Set)}
50       * start with this prefix, which must be unique among all
51       * providers.
52       * </p>
53       * @return the prefix for short periodic coefficients keys
54       * @see #getCoefficients(AbsoluteDate, Set)
55       */
56      String getCoefficientsKeyPrefix();
57  
58      /** Computes the coefficients involved in the contributions.
59       * <p>
60       * This method is intended mainly for validation purposes. Its output
61       * is highly dependent on the implementation details in each force model
62       * and may change from version to version. It is <em>not</em> recommended
63       * to use it for any operational purposes.
64       * </p>
65       * @param date current date
66       * @param selected set of coefficients that should be put in the map
67       * (empty set means all coefficients are selected)
68       * @return the selected coefficients of the short periodic variations,
69       * in a map where all keys start with {@link #getCoefficientsKeyPrefix()}
70       * @throws OrekitException if some specific error occurs
71       */
72      Map<String, double[]> getCoefficients(AbsoluteDate date, Set<String> selected)
73          throws OrekitException;
74  
75  }