1   /* Copyright 2002-2022 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.forces.gravity.potential;
18  
19  import org.orekit.forces.gravity.potential.RawSphericalHarmonicsProvider.RawSphericalHarmonics;
20  import org.orekit.time.AbsoluteDate;
21  
22  /** Wrapper providing un-normalized coefficients.
23   * <p>
24   * The caller <em>must</em> ensure by itself that the raw provider already
25   * stores (and provides) un-normalized coefficients.
26   * </p>
27   * @author Luc Maisonobe
28   * @since 6.0
29   */
30  class WrappingUnnormalizedProvider implements UnnormalizedSphericalHarmonicsProvider {
31  
32      /** Raw provider to which everything is delegated. */
33      private final RawSphericalHarmonicsProvider rawProvider;
34  
35      /** Simple constructor.
36       * @param rawProvider raw provider to which everything is delegated
37       */
38      WrappingUnnormalizedProvider(final RawSphericalHarmonicsProvider rawProvider) {
39          this.rawProvider = rawProvider;
40      }
41  
42      /** {@inheritDoc} */
43      @Override
44      public int getMaxDegree() {
45          return rawProvider.getMaxDegree();
46      }
47  
48      /** {@inheritDoc} */
49      @Override
50      public int getMaxOrder() {
51          return rawProvider.getMaxOrder();
52      }
53  
54      /** {@inheritDoc} */
55      @Override
56      public double getMu() {
57          return rawProvider.getMu();
58      }
59  
60      /** {@inheritDoc} */
61      @Override
62      public double getAe() {
63          return rawProvider.getAe();
64      }
65  
66      /** {@inheritDoc} */
67      @Override
68      public AbsoluteDate getReferenceDate() {
69          return rawProvider.getReferenceDate();
70      }
71  
72      /** {@inheritDoc} */
73      @Deprecated
74      @Override
75      public double getOffset(final AbsoluteDate date) {
76          return rawProvider.getOffset(date);
77      }
78  
79      /** {@inheritDoc} */
80      @Override
81      public TideSystem getTideSystem() {
82          return rawProvider.getTideSystem();
83      }
84  
85      @Override
86      public UnnormalizedSphericalHarmonics onDate(final AbsoluteDate date) {
87          final RawSphericalHarmonics raw = rawProvider.onDate(date);
88          return new UnnormalizedSphericalHarmonics() {
89  
90              /** {@inheritDoc} */
91              @Override
92              public AbsoluteDate getDate() {
93                  return date;
94              }
95  
96              /** {@inheritDoc} */
97              @Override
98              public double getUnnormalizedCnm(final int n, final int m) {
99                  // no conversion is done here
100                 return raw.getRawCnm(n, m);
101             }
102 
103             /** {@inheritDoc} */
104             @Override
105             public double getUnnormalizedSnm(final int n, final int m) {
106                 // no conversion is done here
107                 return raw.getRawSnm(n, m);
108             }
109 
110         };
111     }
112 }