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.adm.apm;
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 import org.orekit.utils.units.Unit;
24
25 /** Keys for {@link ApmQuaternion APM quaternion} entries.
26 * @author Bryan Cazabonne
27 * @since 10.2
28 */
29 public enum ApmQuaternionKey {
30
31 /** Quaternion wrapping element in XML files. */
32 quaternion((token, context, container, epochSetter) -> true),
33
34 /** Quaternion derivative wrapping element in XML files (ADM V1 only). */
35 quaternionRate((token, context, container, epochSetter) -> true),
36
37 /** Quaternion derivative wrapping element in XML files.
38 * @since 12.0
39 */
40 quaternionDot((token, context, container, epochSetter) -> true),
41
42 /** Comment entry. */
43 COMMENT((token, context, container, epochSetter) ->
44 token.getType() == TokenType.ENTRY ? container.addComment(token.getContentAsNormalizedString()) : true),
45
46 /** Epoch entry (only for ADM V1). */
47 EPOCH((token, context, container, epochSetter) -> token.processAsDate(epochSetter, context)),
48
49 /** First reference frame entry (ADM V1 only). */
50 Q_FRAME_A((token, context, container, epochSetter) -> token.processAsFrame(container.getEndpoints()::setFrameA, context, true, true, true)),
51
52 /** First reference frame entry.
53 * @since 12.0
54 */
55 REF_FRAME_A((token, context, container, epochSetter) -> token.processAsFrame(container.getEndpoints()::setFrameA, context, true, true, true)),
56
57 /** Second reference frame entry (ADM V1 only). */
58 Q_FRAME_B((token, context, container, epochSetter) -> token.processAsFrame(container.getEndpoints()::setFrameB, context, true, true, true)),
59
60 /** Second reference frame entry.
61 * @since 12.0
62 */
63 REF_FRAME_B((token, context, container, epochSetter) -> token.processAsFrame(container.getEndpoints()::setFrameB, context, true, true, true)),
64
65 /** Rotation direction entry. */
66 Q_DIR((token, context, container, epochSetter) -> {
67 if (token.getType() == TokenType.ENTRY) {
68 container.getEndpoints().setA2b(token.getContentAsUppercaseCharacter() == 'A');
69 }
70 return true;
71 }),
72
73 /** Scalar part of the quaternion entry. */
74 QC((token, context, container, epochSetter) -> token.processAsIndexedDouble(0, Unit.ONE, context.getParsedUnitsBehavior(),
75 container::setQ)),
76
77 /** First component of the vector part of the quaternion entry. */
78 Q1((token, context, container, epochSetter) -> token.processAsIndexedDouble(1, Unit.ONE, context.getParsedUnitsBehavior(),
79 container::setQ)),
80
81 /** Second component of the vector part of the quaternion entry. */
82 Q2((token, context, container, epochSetter) -> token.processAsIndexedDouble(2, Unit.ONE, context.getParsedUnitsBehavior(),
83 container::setQ)),
84
85 /** Third component of the vector part of the quaternion entry. */
86 Q3((token, context, container, epochSetter) -> token.processAsIndexedDouble(3, Unit.ONE, context.getParsedUnitsBehavior(),
87 container::setQ)),
88
89 /** Scalar part of the quaternion derivative entry. */
90 QC_DOT((token, context, container, epochSetter) -> token.processAsIndexedDouble(0, Units.ONE_PER_S, context.getParsedUnitsBehavior(),
91 container::setQDot)),
92
93 /** First component of the vector part of the quaternion derivative entry. */
94 Q1_DOT((token, context, container, epochSetter) -> token.processAsIndexedDouble(1, Units.ONE_PER_S, context.getParsedUnitsBehavior(),
95 container::setQDot)),
96
97 /** Second component of the vector part of the quaternion derivative entry. */
98 Q2_DOT((token, context, container, epochSetter) -> token.processAsIndexedDouble(2, Units.ONE_PER_S, context.getParsedUnitsBehavior(),
99 container::setQDot)),
100
101 /** Third component of the vector part of the quaternion derivative entry. */
102 Q3_DOT((token, context, container, epochSetter) -> token.processAsIndexedDouble(3, Units.ONE_PER_S, context.getParsedUnitsBehavior(),
103 container::setQDot));
104
105 /** Processing method. */
106 private final transient TokenProcessor processor;
107
108 /** Simple constructor.
109 * @param processor processing method
110 */
111 ApmQuaternionKey(final TokenProcessor processor) {
112 this.processor = processor;
113 }
114
115 /** Process one token.
116 * @param token token to process
117 * @param context context binding
118 * @param container container to fill
119 * @param epochSetter setter for the epoch (used only in ADM V1 XML files)
120 * @return true of token was accepted
121 */
122 public boolean process(final ParseToken token, final ContextBinding context,
123 final ApmQuaternion container, final ParseToken.DateConsumer epochSetter) {
124 return processor.process(token, context, container, epochSetter);
125 }
126
127 /** Interface for processing one token. */
128 interface TokenProcessor {
129 /** Process one token.
130 * @param token token to process
131 * @param context context binding
132 * @param container container to fill
133 * @param epochSetter setter for the epoch (used only in ADM V1 XML files)
134 * @return true of token was accepted
135 */
136 boolean process(ParseToken token, ContextBinding context,
137 ApmQuaternion container, ParseToken.DateConsumer epochSetter);
138 }
139
140 }