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.utils.ContextBinding;
20  import org.orekit.files.ccsds.utils.lexical.ParseToken;
21  
22  
23  /** Keys for {@link OdmCommonMetadata common ODM container} entries.
24   * @author Luc Maisonobe
25   * @since 11.0
26   */
27  public enum CommonMetadataKey {
28  
29      /** Object ID entry. */
30      OBJECT_ID((token, context, container) -> token.processAsUppercaseString(container::setObjectID)),
31  
32      /** Center name entry. */
33      CENTER_NAME((token, context, container) -> token.processAsCenter(container::setCenter,
34                                                                       context.getDataContext().getCelestialBodies())),
35  
36      /** Name of the reference frame in which the state vector and optional Keplerian element data are given. */
37      REF_FRAME((token, context, container) -> token.processAsFrame(container::setReferenceFrame, context, true, false, false)),
38  
39      /** Epoch of reference frame, if not intrinsic to the definition of the reference frame. */
40      REF_FRAME_EPOCH((token, context, container) -> token.processAsUppercaseString(container::setFrameEpochString));
41  
42      /** Processing method. */
43      private final transient TokenProcessor processor;
44  
45      /** Simple constructor.
46       * @param processor processing method
47       */
48      CommonMetadataKey(final TokenProcessor processor) {
49          this.processor = processor;
50      }
51  
52      /** Process one token.
53       * @param token token to process
54       * @param context context binding
55       * @param container container to fill
56       * @return true of token was accepted
57       */
58      public boolean process(final ParseToken token, final ContextBinding context, final OdmCommonMetadata container) {
59          return processor.process(token, context, container);
60      }
61  
62      /** Interface for processing one token. */
63      interface TokenProcessor {
64          /** Process one token.
65           * @param token token to process
66           * @param context context binding
67           * @param container container to fill
68           * @return true of token was accepted
69           */
70          boolean process(ParseToken token, ContextBinding context, OdmCommonMetadata container);
71      }
72  
73  }