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;
18  
19  import org.orekit.files.ccsds.definitions.Units;
20  import org.orekit.files.ccsds.utils.ContextBinding;
21  import org.orekit.files.ccsds.utils.lexical.ParseToken;
22  import org.orekit.files.ccsds.utils.lexical.TokenType;
23  
24  
25  /** Keys for {@link CartesianCovariance OPM/OMM/OCM Cartesian covariance} entries.
26   * @author Luc Maisonobe
27   * @since 11.0
28   */
29  public enum CartesianCovarianceKey {
30  
31      /** Comment entry. */
32      COMMENT((token, context, container) ->
33              token.getType() == TokenType.ENTRY ? container.addComment(token.getContentAsNormalizedString()) : true),
34  
35      /** Epoch entry (only for OEM files). */
36      EPOCH((token, context, container) -> token.processAsDate(container::setEpoch, context)),
37  
38      /** Coordinate system for covariance matrix. */
39      COV_REF_FRAME((token, context, container) -> token.processAsFrame(container::setReferenceFrame, context, true, true, true)),
40  
41      /** Covariance matrix [1, 1] element. */
42      CX_X((token, context, container) -> token.processAsDoublyIndexedDouble(0, 0, Units.KM2, context.getParsedUnitsBehavior(),
43                                                                             container::setCovarianceMatrixEntry)),
44  
45      /** Covariance matrix [2, 1] element. */
46      CY_X((token, context, container) -> token.processAsDoublyIndexedDouble(1, 0, Units.KM2, context.getParsedUnitsBehavior(),
47                                                                             container::setCovarianceMatrixEntry)),
48  
49      /** Covariance matrix [2, 2] element. */
50      CY_Y((token, context, container) -> token.processAsDoublyIndexedDouble(1, 1, Units.KM2, context.getParsedUnitsBehavior(),
51                                                                             container::setCovarianceMatrixEntry)),
52  
53      /** Covariance matrix [3, 1] element. */
54      CZ_X((token, context, container) -> token.processAsDoublyIndexedDouble(2, 0, Units.KM2, context.getParsedUnitsBehavior(),
55                                                                             container::setCovarianceMatrixEntry)),
56  
57      /** Covariance matrix [3, 2] element. */
58      CZ_Y((token, context, container) -> token.processAsDoublyIndexedDouble(2, 1, Units.KM2, context.getParsedUnitsBehavior(),
59                                                                             container::setCovarianceMatrixEntry)),
60  
61      /** Covariance matrix [3, 3] element. */
62      CZ_Z((token, context, container) -> token.processAsDoublyIndexedDouble(2, 2, Units.KM2, context.getParsedUnitsBehavior(),
63                                                                             container::setCovarianceMatrixEntry)),
64  
65      /** Covariance matrix [4, 1] element. */
66      CX_DOT_X((token, context, container) -> token.processAsDoublyIndexedDouble(3, 0, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
67                                                                                 container::setCovarianceMatrixEntry)),
68  
69      /** Covariance matrix [4, 2] element. */
70      CX_DOT_Y((token, context, container) -> token.processAsDoublyIndexedDouble(3, 1, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
71                                                                                 container::setCovarianceMatrixEntry)),
72  
73      /** Covariance matrix [4, 3] element. */
74      CX_DOT_Z((token, context, container) -> token.processAsDoublyIndexedDouble(3, 2, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
75                                                                                 container::setCovarianceMatrixEntry)),
76  
77      /** Covariance matrix [4, 4] element. */
78      CX_DOT_X_DOT((token, context, container) -> token.processAsDoublyIndexedDouble(3, 3, Units.KM2_PER_S2, context.getParsedUnitsBehavior(),
79                                                                                     container::setCovarianceMatrixEntry)),
80  
81      /** Covariance matrix [5, 1] element. */
82      CY_DOT_X((token, context, container) -> token.processAsDoublyIndexedDouble(4, 0, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
83                                                                                 container::setCovarianceMatrixEntry)),
84  
85      /** Covariance matrix [5, 2] element. */
86      CY_DOT_Y((token, context, container) -> token.processAsDoublyIndexedDouble(4, 1, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
87                                                                                 container::setCovarianceMatrixEntry)),
88  
89      /** Covariance matrix [5, 3] element. */
90      CY_DOT_Z((token, context, container) -> token.processAsDoublyIndexedDouble(4, 2, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
91                                                                                 container::setCovarianceMatrixEntry)),
92  
93      /** Covariance matrix [5, 4] element. */
94      CY_DOT_X_DOT((token, context, container) -> token.processAsDoublyIndexedDouble(4, 3, Units.KM2_PER_S2, context.getParsedUnitsBehavior(),
95                                                                                     container::setCovarianceMatrixEntry)),
96  
97      /** Covariance matrix [5, 5] element. */
98      CY_DOT_Y_DOT((token, context, container) -> token.processAsDoublyIndexedDouble(4, 4, Units.KM2_PER_S2, context.getParsedUnitsBehavior(),
99                                                                                     container::setCovarianceMatrixEntry)),
100 
101     /** Covariance matrix [6, 1] element. */
102     CZ_DOT_X((token, context, container) -> token.processAsDoublyIndexedDouble(5, 0, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
103                                                                                container::setCovarianceMatrixEntry)),
104 
105     /** Covariance matrix [6, 2] element. */
106     CZ_DOT_Y((token, context, container) -> token.processAsDoublyIndexedDouble(5, 1, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
107                                                                                container::setCovarianceMatrixEntry)),
108 
109     /** Covariance matrix [6, 3] element. */
110     CZ_DOT_Z((token, context, container) -> token.processAsDoublyIndexedDouble(5, 2, Units.KM2_PER_S, context.getParsedUnitsBehavior(),
111                                                                                container::setCovarianceMatrixEntry)),
112 
113     /** Covariance matrix [6, 4] element. */
114     CZ_DOT_X_DOT((token, context, container) -> token.processAsDoublyIndexedDouble(5, 3, Units.KM2_PER_S2, context.getParsedUnitsBehavior(),
115                                                                                    container::setCovarianceMatrixEntry)),
116 
117     /** Covariance matrix [6, 5] element. */
118     CZ_DOT_Y_DOT((token, context, container) -> token.processAsDoublyIndexedDouble(5, 4, Units.KM2_PER_S2, context.getParsedUnitsBehavior(),
119                                                                                    container::setCovarianceMatrixEntry)),
120 
121     /** Covariance matrix [6, 6] element. */
122     CZ_DOT_Z_DOT((token, context, container) -> token.processAsDoublyIndexedDouble(5, 5, Units.KM2_PER_S2, context.getParsedUnitsBehavior(),
123                                                                                    container::setCovarianceMatrixEntry));
124 
125     /** Processing method. */
126     private final transient TokenProcessor processor;
127 
128     /** Simple constructor.
129      * @param processor processing method
130      */
131     CartesianCovarianceKey(final TokenProcessor processor) {
132         this.processor = processor;
133     }
134 
135     /** Process one token.
136      * @param token token to process
137      * @param context context binding
138      * @param container container to fill
139      * @return true of token was accepted
140      */
141     public boolean process(final ParseToken token, final ContextBinding context, final CartesianCovariance container) {
142         return processor.process(token, context, container);
143     }
144 
145     /** Interface for processing one token. */
146     interface TokenProcessor {
147         /** Process one token.
148          * @param token token to process
149          * @param context context binding
150          * @param container container to fill
151          * @return true of token was accepted
152          */
153         boolean process(ParseToken token, ContextBinding context, CartesianCovariance container);
154     }
155 
156 }