1   /* Copyright 2022-2025 Luc Maisonobe
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.acm;
18  
19  import java.io.IOException;
20  import java.util.stream.Collectors;
21  
22  import org.orekit.files.ccsds.definitions.TimeConverter;
23  import org.orekit.files.ccsds.ndm.adm.AdmMetadataKey;
24  import org.orekit.files.ccsds.section.AbstractWriter;
25  import org.orekit.files.ccsds.section.KvnStructureKey;
26  import org.orekit.files.ccsds.section.MetadataKey;
27  import org.orekit.files.ccsds.section.XmlStructureKey;
28  import org.orekit.files.ccsds.utils.generation.Generator;
29  import org.orekit.utils.units.Unit;
30  
31  /**
32   * Writer for Common metadata for CCSDS Attitude Comprehensive Messages.
33   *
34   * @author Luc Maisonobe
35   * @since 12.0
36   */
37  class AcmMetadataWriter extends AbstractWriter {
38  
39      /** Metadata. */
40      private final AcmMetadata metadata;
41  
42      /** Converter for dates. */
43      private final TimeConverter timeConverter;
44  
45      /** Simple constructor.
46       * @param metadata metadata to write
47       * @param timeConverter converter for dates
48       */
49      AcmMetadataWriter(final AcmMetadata metadata, final TimeConverter timeConverter) {
50          super(XmlStructureKey.metadata.name(), KvnStructureKey.META.name());
51          this.metadata      = metadata;
52          this.timeConverter = timeConverter;
53      }
54  
55      /** {@inheritDoc} */
56      @Override
57      protected void writeContent(final Generator generator) throws IOException {
58  
59          generator.writeComments(metadata.getComments());
60  
61          // object
62          generator.writeEntry(AdmMetadataKey.OBJECT_NAME.name(),
63                               metadata.getObjectName(), null, false);
64          generator.writeEntry(AcmMetadataKey.INTERNATIONAL_DESIGNATOR.name(),
65                               metadata.getInternationalDesignator(), null, false);
66          generator.writeEntry(AcmMetadataKey.CATALOG_NAME.name(),
67                               metadata.getCatalogName(), null, false);
68          generator.writeEntry(AcmMetadataKey.OBJECT_DESIGNATOR.name(),
69                               metadata.getObjectDesignator(), null, false);
70  
71          // originator
72          generator.writeEntry(AcmMetadataKey.ORIGINATOR_POC.name(),
73                               metadata.getOriginatorPOC(), null, false);
74          generator.writeEntry(AcmMetadataKey.ORIGINATOR_POSITION.name(),
75                               metadata.getOriginatorPosition(), null, false);
76          generator.writeEntry(AcmMetadataKey.ORIGINATOR_PHONE.name(),
77                               metadata.getOriginatorPhone(), null, false);
78          generator.writeEntry(AcmMetadataKey.ORIGINATOR_EMAIL.name(),
79                               metadata.getOriginatorEmail(), null, false);
80          generator.writeEntry(AcmMetadataKey.ORIGINATOR_ADDRESS.name(),
81                               metadata.getOriginatorAddress(), null, false);
82  
83          // messages
84          generator.writeEntry(AcmMetadataKey.ODM_MSG_LINK.name(),
85                               metadata.getOdmMessageLink(), null, false);
86  
87          // time
88          if (metadata.getCenter() != null) {
89              generator.writeEntry(AdmMetadataKey.CENTER_NAME.name(), metadata.getCenter().getName(), null, false);
90          }
91          generator.writeEntry(MetadataKey.TIME_SYSTEM.name(),
92                               metadata.getTimeSystem(), false);
93          generator.writeEntry(AcmMetadataKey.EPOCH_TZERO.name(), timeConverter,
94                               metadata.getEpochT0(), true, true);
95  
96          // definitions
97          if (metadata.getAcmDataElements() != null) {
98              generator.writeEntry(AcmMetadataKey.ACM_DATA_ELEMENTS.name(),
99                                   metadata.getAcmDataElements().stream().map(Enum::name).collect(Collectors.toList()), false);
100         }
101 
102         // other times
103         generator.writeEntry(AcmMetadataKey.START_TIME.name(), timeConverter,
104                              metadata.getStartTime(), false, false);
105         generator.writeEntry(AcmMetadataKey.STOP_TIME.name(), timeConverter,
106                              metadata.getStopTime(), false, false);
107         generator.writeEntry(AcmMetadataKey.TAIMUTC_AT_TZERO.name(), metadata.getTaimutcT0(), Unit.SECOND, false);
108         if (metadata.getNextLeapEpoch() != null) {
109             generator.writeEntry(AcmMetadataKey.NEXT_LEAP_EPOCH.name(), timeConverter,
110                                  metadata.getNextLeapEpoch(), true, true);
111             generator.writeEntry(AcmMetadataKey.NEXT_LEAP_TAIMUTC.name(), metadata.getNextLeapTaimutc(), Unit.SECOND, true);
112         }
113 
114     }
115 
116 }