1   /* Copyright 2022-2026 Romain Serra
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.orbits;
18  
19  /**
20   * Data container for circular orbital elements.
21   * @param a semi-major axis
22   * @param ex first component of the eccentricity vector
23   * @param ey second component of the eccentricity vector
24   * @param i inclination
25   * @param raan right ascension of ascending node
26   * @param latitudeArgument argument of latitude corresponding to angle type
27   * @param positionAngleType angle type
28   * @author Romain Serra
29   * @see PositionAngleType
30   * @since 14.0
31   */
32  public record CircularParameters(double a, double ex, double ey, double i, double raan, double latitudeArgument,
33                                   PositionAngleType positionAngleType) {
34  
35      /**
36       * Builds a new instance with the specified position angle type.
37       * @param angleType angle type for the output
38       * @return circular elements with the specified position angle type
39       */
40      public CircularParameters withPositionAngleType(final PositionAngleType angleType) {
41          final double convertedArgument = CircularLatitudeArgumentUtility.convertAlpha(positionAngleType, latitudeArgument, ex, ey, angleType);
42          return new CircularParameters(a, ex, ey, i, raan, convertedArgument, angleType);
43      }
44  
45  }