TimeStampedField.java

  1. /* Copyright 2002-2024 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.time;

  18. import org.hipparchus.CalculusFieldElement;

  19. /**
  20.  * Class that associates a field with a date.
  21.  *
  22.  * @author Vincent Cucchietti
  23.  * @see FieldAbsoluteDate
  24.  * @see CalculusFieldElement
  25.  * @param <KK> type of the field elements
  26.  */
  27. public class TimeStampedField<KK extends CalculusFieldElement<KK>> implements FieldTimeStamped<KK> {

  28.     /** Date. */
  29.     private final FieldAbsoluteDate<KK> date;

  30.     /** Value. */
  31.     private final KK value;

  32.     /**
  33.      * Constructor with normal date.
  34.      *
  35.      * @param value value
  36.      * @param date date associated to value
  37.      */
  38.     public TimeStampedField(final KK value, final AbsoluteDate date) {
  39.         this(value, new FieldAbsoluteDate<>(value.getField(), date));
  40.     }

  41.     /**
  42.      * Constructor.
  43.      *
  44.      * @param value value
  45.      * @param date date associated to value
  46.      */
  47.     public TimeStampedField(final KK value, final FieldAbsoluteDate<KK> date) {
  48.         this.date  = date;
  49.         this.value = value;
  50.     }

  51.     /** {@inheritDoc} */
  52.     @Override
  53.     public FieldAbsoluteDate<KK> getDate() {
  54.         return date;
  55.     }

  56.     /** Get value.
  57.      * @return value
  58.      */
  59.     public KK getValue() {
  60.         return value;
  61.     }

  62. }