FieldClocksDifference.java

/* Copyright 2022-2026 Thales Alenia Space
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.time.clocks;

import org.hipparchus.CalculusFieldElement;

/** Clock model computing the difference of two underlying models.
 * @param <T> type of the field elements
 * @author Luc Maisonobe
 * @since 14.0
 */
public class FieldClocksDifference<T extends CalculusFieldElement<T>>
    extends AbstractCombinedFieldClocksPair<T> {

    /** Simple constructor.
     * <p>
     * The combined clock is {@code clock1 - clock2}
     * </p>
     * @param clock1 first underlying clock
     * @param clock2 second underlying clock
     */
    public FieldClocksDifference(final FieldClockModel<T> clock1, final FieldClockModel<T> clock2) {
        super(clock1, clock2);
    }

    /** {@inheritDoc} */
    @Override
    protected FieldClockOffset<T> combine(final FieldClockOffset<T> offset1, final FieldClockOffset<T> offset2) {
        return offset1.subtract(offset2);
    }

    /** {@inheritDoc} */
    @Override
    public ClocksDifference toNonField() {
        return new ClocksDifference(getClock1().toNonField(), getClock2().toNonField());
    }

}