1 /* Copyright 2002-2025 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.files.ccsds.ndm.tdm;
18
19 import org.orekit.time.AbsoluteDate;
20
21 /** Interface for converting {@link RangeUnits#RU Range Units} to meters.
22 * <p>
23 * Implementations of this interface must be provided by user when dealing
24 * with {@link Tdm Tracking Data Messages} that include range observations
25 * in {@link RangeUnits#RU Range Units}. These units are intended for mission-specific
26 * measurements and must be described in an Interface Control Document.
27 * </p>
28 * @author Luc Maisonobe
29 * @since 11.0
30 */
31 public interface RangeUnitsConverter {
32
33 /** Convert a range expressed in {@link RangeUnits#RU Range Units}.
34 * @param metadata metadata corresponding to the observation
35 * @param date observation date
36 * @param range range value in {@link RangeUnits#RU Range Units}
37 * @return range range value in meters
38 */
39 double ruToMeters(TdmMetadata metadata, AbsoluteDate date, double range);
40
41 /** Convert a range expressed in meters.
42 * @param metadata metadata corresponding to the observation
43 * @param date observation date
44 * @param range range value in meters
45 * @return range range value in {@link RangeUnits#RU Range Units}
46 */
47 double metersToRu(TdmMetadata metadata, AbsoluteDate date, double range);
48
49 }