ManeuverFieldType.java

  1. /* Copyright 2002-2025 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.files.ccsds.ndm.odm.ocm;

  19. import org.hipparchus.util.Precision;
  20. import org.orekit.errors.OrekitException;
  21. import org.orekit.errors.OrekitMessages;
  22. import org.orekit.files.ccsds.definitions.OnOff;
  23. import org.orekit.files.ccsds.definitions.TimeConverter;
  24. import org.orekit.files.ccsds.utils.ContextBinding;
  25. import org.orekit.time.DateTimeComponents;
  26. import org.orekit.utils.AccurateFormatter;
  27. import org.orekit.utils.Formatter;
  28. import org.orekit.utils.units.Unit;

  30. /** Maneuver field type used in CCSDS {@link Ocm Orbit Comprehensive Messages}.
  31.  * @author Luc Maisonobe
  32.  * @since 11.0
  33.  */
  34. public enum ManeuverFieldType {

  36.     // CHECKSTYLE: stop MultipleStringLiterals check

  38.     /** Absolute epoch time. */
  39.     TIME_ABSOLUTE("n/a",
  40.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDate(context.getTimeSystem().getConverter(context).parse(field)),
  41.         (u, converter, maneuver, formatter) -> {
  42.             final DateTimeComponents dt = converter.components(maneuver.getDate());
  43.             return formatter.toString(dt.getDate().getYear(), dt.getDate().getMonth(), dt.getDate().getDay(),
  44.                     dt.getTime().getHour(), dt.getTime().getMinute(), dt.getTime().getSecond());
  45.         }),

  47.     /** Relative epoch time. */
  48.     TIME_RELATIVE("s",
  49.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDate(context.getReferenceDate().shiftedBy(toSI(field, u))),
  50.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(converter.offset(maneuver.getDate())))),

  52.     /** Maneuver duration. */
  53.     MAN_DURA("s",
  54.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDuration(toSI(field, u)),
  55.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDuration()))),

  57.     /** Mass change. */
  58.     DELTA_MASS("kg",
  59.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeltaMass(toSI(field, u)),
  60.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeltaMass()))),

  62.     /** Acceleration along X axis. */
  63.     ACC_X("km/s²",
  64.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setAcceleration(0, toSI(field, u)),
  65.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getAcceleration().getX()))),

  67.     /** Acceleration along Y axis. */
  68.     ACC_Y("km/s²",
  69.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setAcceleration(1, toSI(field, u)),
  70.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getAcceleration().getY()))),

  72.     /** Acceleration along Z axis. */
  73.     ACC_Z("km/s²",
  74.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setAcceleration(2, toSI(field, u)),
  75.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getAcceleration().getZ()))),

  77.     /** Interpolation mode between current and next acceleration line. */
  78.     ACC_INTERP("n/a",
  79.         (field, u, context, maneuver, lineNumber, fileName) -> {
  80.             try {
  81.                 maneuver.setAccelerationInterpolation(OnOff.valueOf(field));
  82.             } catch (IllegalArgumentException iae) {
  83.                 throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD,
  84.                                           lineNumber, fileName, field);
  85.             }
  86.         },
  87.         (u, converter, maneuver, formatter) -> maneuver.getAccelerationInterpolation().name()),

  89.     /** One σ percent error on acceleration magnitude. */
  90.     ACC_MAG_SIGMA("%",
  91.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setAccelerationMagnitudeSigma(toSI(field, u)),
  92.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getAccelerationMagnitudeSigma()))),

  94.     /** One σ off-nominal acceleration direction. */
  95.     ACC_DIR_SIGMA("°",
  96.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setAccelerationDirectionSigma(toSI(field, u)),
  97.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getAccelerationDirectionSigma()))),

  99.     /** Velocity increment along X axis. */
  100.     DV_X("km/s",
  101.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDv(0, toSI(field, u)),
  102.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDv().getX()))),

  104.     /** Velocity increment along Y axis. */
  105.     DV_Y("km/s",
  106.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDv(1, toSI(field, u)),
  107.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDv().getY()))),

  109.     /** Velocity increment along Z axis. */
  110.     DV_Z("km/s",
  111.         (field, u, context, maneuver, lineNumber, fileName) ->  maneuver.setDv(2, toSI(field, u)),
  112.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDv().getZ()))),

  114.     /** One σ percent error on ΔV magnitude. */
  115.     DV_MAG_SIGMA("%",
  116.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDvMagSigma(toSI(field, u)),
  117.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDvMagSigma()))),

  119.     /** One σ angular off-nominal ΔV direction. */
  120.     DV_DIR_SIGMA("°",
  121.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDvDirSigma(toSI(field, u)),
  122.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDvDirSigma()))),

  124.     /** Thrust component along X axis. */
  125.     THR_X("N",
  126.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setThrust(0, toSI(field, u)),
  127.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getThrust().getX()))),

  129.     /** Thrust component along Y axis. */
  130.     THR_Y("N",
  131.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setThrust(1, toSI(field, u)),
  132.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getThrust().getY()))),

  134.     /** Thrust component along Z axis. */
  135.     THR_Z("N",
  136.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setThrust(2, toSI(field, u)),
  137.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getThrust().getZ()))),

  139.     /** Thrust efficiency η typically between 0.0 and 1.0. */
  140.     THR_EFFIC("n/a",
  141.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setThrustEfficiency(toSI(field, u)),
  142.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getThrustEfficiency()))),

  144.     /** Interpolation mode between current and next acceleration line. */
  145.     THR_INTERP("n/a",
  146.         (field, u, context, maneuver, lineNumber, fileName) -> {
  147.             try {
  148.                 maneuver.setThrustInterpolation(OnOff.valueOf(field));
  149.             } catch (IllegalArgumentException iae) {
  150.                 throw new OrekitException(OrekitMessages.CCSDS_UNEXPECTED_KEYWORD,
  151.                                           lineNumber, fileName, field);
  152.             }
  153.         },
  154.         (u, converter, maneuver, formatter) -> maneuver.getThrustInterpolation().name()),

  156.     /** Thrust specific impulse. */
  157.     THR_ISP("s",
  158.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setThrustIsp(toSI(field, u)),
  159.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getThrustIsp()))),

  161.     /** One σ percent error on thrust magnitude. */
  162.     THR_MAG_SIGMA("%",
  163.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setThrustMagnitudeSigma(toSI(field, u)),
  164.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getThrustMagnitudeSigma()))),

  166.     /** One σ angular off-nominal thrust direction. */
  167.     THR_DIR_SIGMA("°",
  168.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setThrustDirectionSigma(toSI(field, u)),
  169.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getThrustDirectionSigma()))),

  171.     /** Identifier of resulting "child" object deployed from this host. */
  172.     DEPLOY_ID("n/a",
  173.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployId(field),
  174.         (u, converter, maneuver, formatter) -> maneuver.getDeployId()),

  176.     /** Velocity increment of deployed "child" object along X axis. */
  177.     DEPLOY_DV_X("km/s",
  178.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployDv(0, toSI(field, u)),
  179.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployDv().getX()))),

  181.     /** Velocity increment of deployed "child" object along Y axis. */
  182.     DEPLOY_DV_Y("km/s",
  183.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployDv(1, toSI(field, u)),
  184.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployDv().getY()))),

  186.     /** Velocity increment of deployed "child" object along Z axis. */
  187.     DEPLOY_DV_Z("km/s",
  188.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployDv(2, toSI(field, u)),
  189.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployDv().getZ()))),

  191.     /** Decrement in host mass as a result of deployment (shall be ≤ 0). */
  192.     DEPLOY_MASS("kg",
  193.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployMass(toSI(field, u)),
  194.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployMass()))),

  196.     /** One σ percent error on deployment ΔV magnitude. */
  197.     DEPLOY_DV_SIGMA("%",
  198.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployDvSigma(toSI(field, u)),
  199.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployDvSigma()))),

  201.     /** One σ angular off-nominal deployment vector direction. */
  202.     DEPLOY_DIR_SIGMA("°",
  203.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployDirSigma(toSI(field, u)),
  204.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployDirSigma()))),

  206.     /** Ratio of child-to-host ΔV vectors. */
  207.     DEPLOY_DV_RATIO("n/a",
  208.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployDvRatio(toSI(field, u)),
  209.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployDvRatio()))),

  211.     /** Typical (50th percentile) product of drag coefficient times cross-sectional area of deployed "child" object. */
  212.     DEPLOY_DV_CDA("m²",
  213.         (field, u, context, maneuver, lineNumber, fileName) -> maneuver.setDeployDvCda(toSI(field, u)),
  214.         (u, converter, maneuver, formatter) -> formatter.toString(u.fromSI(maneuver.getDeployDvCda())));


  217.     // CHECKSTYLE: resume MultipleStringLiterals check

  219.     /** Elements units. */
  220.     private final Unit unit;

  222.     /** Processing method. */
  223.     private final transient FieldProcessor processor;

  225.     /** Writing method. */
  226.     private final transient FieldWriter writer;

  228.     /** Simple constructor.
  229.      * @param unitSpecifications field unit specifications
  230.      * @param processor field processing method
  231.      * @param writer field writing method
  232.      */
  233.     ManeuverFieldType(final String unitSpecifications, final FieldProcessor processor, final FieldWriter writer) {
  234.         this.unit      = Unit.parse(unitSpecifications);
  235.         this.processor = processor;
  236.         this.writer    = writer;
  237.     }

  239.     /** Get the field unit.
  240.      * @return field unit
  241.      */
  242.     public Unit getUnit() {
  243.         return unit;
  244.     }

  246.     /** Check if parsed unit is compatible with field type.
  247.      * @param parsedUnit unit to check
  248.      */
  249.     public void checkUnit(final Unit parsedUnit) {
  250.         if (unit == Unit.NONE ^ parsedUnit == Unit.NONE ||
  251.             !(unit.sameDimension(parsedUnit) && Precision.equals(unit.getScale(), parsedUnit.getScale(), 1))) {
  252.             throw new OrekitException(OrekitMessages.INCOMPATIBLE_UNITS,
  253.                                       unit.getName(), parsedUnit.getName());
  254.         }
  255.     }

  257.     /** Check if a field is a time field.
  258.      * @return true if field is a time field
  259.      */
  260.     public boolean isTime() {
  261.         return this == TIME_ABSOLUTE || this == TIME_RELATIVE;
  262.     }

  264.     /** Get the value in SI units corresponding to a field.
  265.      * @param field text field
  266.      * @param unit unit to use
  267.      * @return double value in SI units
  268.      */
  269.     private static double toSI(final String field, final Unit unit) {
  270.         return unit.toSI(Double.parseDouble(field));
  271.     }

  273.     /** Process one field.
  274.      * @param field field to process
  275.      * @param context context binding
  276.      * @param maneuver maneuver to fill
  277.      * @param lineNumber line number at which the field occurs
  278.      * @param fileName name of the file in which the field occurs
  279.      */
  280.     public void process(final String field, final ContextBinding context, final OrbitManeuver maneuver,
  281.                         final int lineNumber, final String fileName) {
  282.         processor.process(field, unit, context, maneuver, lineNumber, fileName);
  283.     }

  285.     /** Output one maneuver field.
  286.      * @param converter converter for dates
  287.      * @param maneuver maneuver containing the field to output
  288.      * @param formatter used format doubles and dates to strings
  289.      * @return output field
  290.      */
  291.     public String outputField(final TimeConverter converter, final OrbitManeuver maneuver, final Formatter formatter)  {
  292.         return writer.output(unit, converter, maneuver, formatter);
  293.     }

  295.     /** Output one maneuver field.
  296.      * @param converter converter for dates
  297.      * @param maneuver maneuver containing the field to output
  298.      * @return output field
  299.      * @deprecated since 13.0, because formatter should be specified. Use {@link ManeuverFieldType#outputField(TimeConverter, OrbitManeuver, Formatter)} instead.
  300.      */
  301.     @Deprecated
  302.     public String outputField(final TimeConverter converter, final OrbitManeuver maneuver) {
  303.         return writer.output(unit, converter, maneuver, new AccurateFormatter());
  304.     }

  306.     /** Interface for processing one field. */
  307.     interface FieldProcessor {
  308.         /** Process one field.
  309.          * @param field field to process
  310.          * @param unit unit to use
  311.          * @param context context binding
  312.          * @param maneuver maneuver to fill
  313.          * @param lineNumber line number at which the field occurs
  314.          * @param fileName name of the file in which the field occurs
  315.          */
  316.         void process(String field, Unit unit, ContextBinding context, OrbitManeuver maneuver,
  317.                      int lineNumber, String fileName);
  318.     }

  320.     /** Interface for writing one field based on formatting standards. */
  321.     interface FieldWriter {
  322.         /** Process one field.
  323.          * @param unit unit to use
  324.          * @param converter converter for dates
  325.          * @param maneuver maneuver containing the field to output
  326.          * @param formatter used to format dates and doubles to string
  327.          * @return output field
  328.          */
  329.         String output(Unit unit, TimeConverter converter, OrbitManeuver maneuver, Formatter formatter);
  330.     }

  332. }
Created with JaCoCo 0.8.12.202403310830