ExtendedPVCoordinatesProvider.java

  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.utils;

  18. import org.hipparchus.Field;
  19. import org.hipparchus.CalculusFieldElement;
  20. import org.orekit.frames.Frame;
  21. import org.orekit.time.FieldAbsoluteDate;

  22. /**
  23. ** Interface for PV coordinates providers that also support fields.
  24.  * @since 9.2
  25.  * @author Luc Maisonobe
  26.  */
  27. public interface ExtendedPVCoordinatesProvider extends PVCoordinatesProvider {

  28.     /** Convert to a {@link FieldPVCoordinatesProvider} with a specific type.
  29.      * @param <T> the type of the field elements
  30.      * @param field field for the argument and value
  31.      * @return converted function
  32.      */
  33.     default <T extends CalculusFieldElement<T>> FieldPVCoordinatesProvider<T> toFieldPVCoordinatesProvider(Field<T> field) {
  34.         return this::getPVCoordinates;
  35.     }

  36.     /** Get the {@link FieldPVCoordinates} of the body in the selected frame.
  37.      * @param date current date
  38.      * @param frame the frame where to define the position
  39.      * @param <T> type for the field elements
  40.      * @return time-stamped position/velocity of the body (m and m/s)
  41.      */
  42.     <T extends CalculusFieldElement<T>>TimeStampedFieldPVCoordinates<T> getPVCoordinates(FieldAbsoluteDate<T> date,
  43.                                                                                      Frame frame);

  44. }