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 java.io.IOException;
20  
21  import org.orekit.files.ccsds.definitions.TimeConverter;
22  import org.orekit.files.ccsds.section.AbstractWriter;
23  import org.orekit.files.ccsds.section.MetadataKey;
24  import org.orekit.files.ccsds.section.XmlStructureKey;
25  import org.orekit.files.ccsds.utils.generation.Generator;
26  
27  /**
28   * Writer for Common metadata for CCSDS Orbit Parameter/Ephemeris/Mean Messages.
29   *
30   * @author Luc Maisonobe
31   * @since 11.0
32   */
33  public class CommonMetadataWriter extends AbstractWriter {
34  
35      /** Metadata. */
36      private final OdmCommonMetadata metadata;
37  
38      /** Converter for dates. */
39      private final TimeConverter timeConverter;
40  
41      /** Simple constructor.
42       * @param metadata metadata to write
43       * @param timeConverter converter for dates
44       */
45      public CommonMetadataWriter(final OdmCommonMetadata metadata, final TimeConverter timeConverter) {
46          super(XmlStructureKey.metadata.name(), null);
47          this.metadata      = metadata;
48          this.timeConverter = timeConverter;
49      }
50  
51      /** {@inheritDoc} */
52      @Override
53      protected void writeContent(final Generator generator) throws IOException {
54  
55          generator.writeComments(metadata.getComments());
56  
57          // object
58          generator.writeEntry(OdmMetadataKey.OBJECT_NAME.name(),  metadata.getObjectName(), null, true);
59          generator.writeEntry(CommonMetadataKey.OBJECT_ID.name(), metadata.getObjectID(),   null, true);
60  
61          // frames
62          generator.writeEntry(CommonMetadataKey.CENTER_NAME.name(),     metadata.getCenter().getName(),          null, true);
63          generator.writeEntry(CommonMetadataKey.REF_FRAME.name(),       metadata.getReferenceFrame().getName(),  null, true);
64          generator.writeEntry(CommonMetadataKey.REF_FRAME_EPOCH.name(), timeConverter, metadata.getFrameEpoch(), true, false);
65  
66          // time
67          generator.writeEntry(MetadataKey.TIME_SYSTEM.name(),   metadata.getTimeSystem(), true);
68  
69      }
70  
71  }