L1Frame.java

/* Copyright 2002-2018 CS Systèmes d'Information
 * Licensed to CS Systèmes d'Information (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.frames;

import org.orekit.bodies.CelestialBody;
import org.orekit.errors.OrekitException;
import org.orekit.utils.AngularDerivativesFilter;
import org.orekit.utils.CartesianDerivativesFilter;
import org.orekit.utils.Constants;
import org.orekit.utils.OrekitConfiguration;

/** Class to create a L1 centered frame with {@link L1TransformProvider}.
 *  Parent frame is always set as primaryBody.getInertiallyOrientedFrame()
 * @author Luc Maisonobe
 * @author Julio Hernanz
 */
public class L1Frame extends Frame {

    /** Serializable UID.*/
    private static final long serialVersionUID = 20170811L;

    /** Simple constructor.
     * @param primaryBody Celestial body with bigger mass, m1.
     * @param secondaryBody Celestial body with smaller mass, m2.
     * @exception OrekitException If frame cannot be retrieved from {@code primaryBody}.
     */
    public L1Frame(final CelestialBody primaryBody, final CelestialBody secondaryBody)
        throws OrekitException {
        super(primaryBody.getInertiallyOrientedFrame(),
              new ShiftingTransformProvider(new L1TransformProvider(primaryBody, secondaryBody),
                                            CartesianDerivativesFilter.USE_P,
                                            AngularDerivativesFilter.USE_R,
                                            5, Constants.JULIAN_DAY / 24,
                                            OrekitConfiguration.getCacheSlotsNumber(),
                                            Constants.JULIAN_YEAR, 30 * Constants.JULIAN_DAY),
              primaryBody.getName() + "-" + secondaryBody.getName() + "-L1", true);
    }

}