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.cdm;
18  
19  import java.io.IOException;
20  
21  import org.hipparchus.geometry.euclidean.threed.Vector3D;
22  import org.orekit.data.DataContext;
23  import org.orekit.files.ccsds.definitions.TimeSystem;
24  import org.orekit.files.ccsds.definitions.Units;
25  import org.orekit.files.ccsds.ndm.ParsedUnitsBehavior;
26  import org.orekit.files.ccsds.section.Segment;
27  import org.orekit.files.ccsds.section.XmlStructureKey;
28  import org.orekit.files.ccsds.utils.ContextBinding;
29  import org.orekit.files.ccsds.utils.FileFormat;
30  import org.orekit.files.ccsds.utils.generation.Generator;
31  import org.orekit.utils.IERSConventions;
32  import org.orekit.utils.units.Unit;
33  
34  /**
35   * Writer for CCSDS Conjunction Data Message.
36   *
37   * @author Melina Vanel
38   * @since 11.2
39   */
40  public class CdmWriter extends CdmMessageWriter {
41  
42      /** Version number implemented. **/
43      public static final double CCSDS_CDM_VERS = 1.0;
44  
45      /** Padding width for aligning the '=' sign. */
46      public static final int KVN_PADDING_WIDTH = 17;
47  
48      /** */
49      private final Vector3D NANVECTOR = new Vector3D(Double.NaN, Double.NaN, Double.NaN);
50  
51      /** Complete constructor.
52       * <p>
53       * Calling this constructor directly is not recommended. Users should rather use
54       * {@link org.orekit.files.ccsds.ndm.WriterBuilder#buildCdmWriter()
55       * writerBuilder.buildCdmWriter()}.
56       * </p>
57       * @param conventions IERS Conventions
58       * @param dataContext used to retrieve frames, time scales, etc.
59       */
60      public CdmWriter(final IERSConventions conventions, final DataContext dataContext) {
61          super(Cdm.ROOT, Cdm.FORMAT_VERSION_KEY, CCSDS_CDM_VERS,
62                new ContextBinding(
63                    () -> conventions,
64                    () -> false, () -> dataContext, () -> ParsedUnitsBehavior.STRICT_COMPLIANCE,
65                    () -> null, () -> TimeSystem.UTC,
66                    () -> 0.0, () -> 1.0));
67      }
68  
69      /** {@inheritDoc} */
70      @Override
71      public void writeSegmentContent(final Generator generator, final double formatVersion,
72                                      final Segment<CdmMetadata, CdmData> segment)
73          throws IOException {
74  
75          // write the metadata
76          final ContextBinding oldContext = getContext();
77          final CdmMetadata    metadata   = segment.getMetadata();
78          setContext(new ContextBinding(oldContext::getConventions,
79                                        oldContext::isSimpleEOP,
80                                        oldContext::getDataContext,
81                                        oldContext::getParsedUnitsBehavior,
82                                        oldContext::getReferenceDate,
83                                        metadata::getTimeSystem,
84                                        oldContext::getClockCount,
85                                        oldContext::getClockRate));
86          new CdmMetadataWriter(metadata).write(generator);
87  
88          // start data block
89          if (generator.getFormat() == FileFormat.XML) {
90              generator.enterSection(XmlStructureKey.data.name());
91          }
92  
93          if (segment.getData().getODParametersBlock() != null) {
94              // write optional OD parameters block
95              generator.writeComments(segment.getData().getComments());
96              new ODParametersWriter(XmlSubStructureKey.odParameters.name(), null,
97                                     segment.getData().getODParametersBlock(), getTimeConverter()).
98              write(generator);
99          }
100 
101         if (segment.getData().getAdditionalParametersBlock() != null) {
102             // write optional additional parameters block
103             new AdditionalParametersWriter(XmlSubStructureKey.additionalParameters.name(), null,
104                             segment.getData().getAdditionalParametersBlock()).
105             write(generator);
106         }
107 
108         // write mandatory state vector block
109         new StateVectorWriter(XmlSubStructureKey.stateVector.name(), null,
110                                  segment.getData().getStateVectorBlock()).
111         write(generator);
112 
113         // write mandatory RTN covariance block
114         new RTNCovarianceWriter(XmlSubStructureKey.covarianceMatrix.name(), null,
115                                  segment.getData().getRTNCovarianceBlock()).
116         write(generator);
117 
118         // stop data block
119         if (generator.getFormat() == FileFormat.XML) {
120             generator.exitSection();
121         }
122 
123     }
124 
125     @Override
126     public void writeRelativeMetadataContent(final Generator generator, final double formatVersion,
127                                              final CdmRelativeMetadata relativeMetadata) throws IOException {
128 
129         // Is written only once
130         // start relative metadata block
131         if (generator.getFormat() == FileFormat.XML) {
132             generator.enterSection(XmlSubStructureKey.relativeMetadataData.name());
133         }
134         generator.writeComments(relativeMetadata.getComment());
135 
136         generator.writeEntry(CdmRelativeMetadataKey.TCA.name(), getTimeConverter(), relativeMetadata.getTca(), true, true);
137         generator.writeEntry(CdmRelativeMetadataKey.MISS_DISTANCE.name(), relativeMetadata.getMissDistance(), Unit.METRE, true);
138         generator.writeEntry(CdmRelativeMetadataKey.RELATIVE_SPEED.name(), relativeMetadata.getRelativeSpeed(), Units.M_PER_S, false);
139 
140         // start relative state vector block
141         if (generator.getFormat() == FileFormat.XML && (relativeMetadata.getRelativePosition() != NANVECTOR ||
142             relativeMetadata.getRelativeVelocity() != NANVECTOR)) {
143             generator.enterSection(XmlSubStructureKey.relativeStateVector.name());
144         }
145 
146         if (relativeMetadata.getRelativePosition() != NANVECTOR) {
147             generator.writeEntry(CdmRelativeMetadataKey.RELATIVE_POSITION_R.name(),
148                                  relativeMetadata.getRelativePosition().getX(), Unit.METRE, false);
149             generator.writeEntry(CdmRelativeMetadataKey.RELATIVE_POSITION_T.name(),
150                                  relativeMetadata.getRelativePosition().getY(), Unit.METRE, false);
151             generator.writeEntry(CdmRelativeMetadataKey.RELATIVE_POSITION_N.name(),
152                                  relativeMetadata.getRelativePosition().getZ(), Unit.METRE, false);
153         }
154         if (relativeMetadata.getRelativeVelocity() != NANVECTOR) {
155             generator.writeEntry(CdmRelativeMetadataKey.RELATIVE_VELOCITY_R.name(),
156                                  relativeMetadata.getRelativeVelocity().getX(), Units.M_PER_S, false);
157             generator.writeEntry(CdmRelativeMetadataKey.RELATIVE_VELOCITY_T.name(),
158                                  relativeMetadata.getRelativeVelocity().getY(), Units.M_PER_S, false);
159             generator.writeEntry(CdmRelativeMetadataKey.RELATIVE_VELOCITY_N.name(),
160                                  relativeMetadata.getRelativeVelocity().getZ(), Units.M_PER_S, false);
161         }
162 
163         // stop relative state vector block
164         if (generator.getFormat() == FileFormat.XML &&
165             (relativeMetadata.getRelativePosition() != NANVECTOR || relativeMetadata.getRelativeVelocity() != NANVECTOR)) {
166             generator.exitSection();
167         }
168 
169         generator.writeEntry(CdmRelativeMetadataKey.START_SCREEN_PERIOD.name(), getTimeConverter(),
170                              relativeMetadata.getStartScreenPeriod(), true, false);
171         generator.writeEntry(CdmRelativeMetadataKey.STOP_SCREEN_PERIOD.name(),  getTimeConverter(),
172                              relativeMetadata.getStopScreenPeriod(), true, false);
173         generator.writeEntry(CdmRelativeMetadataKey.SCREEN_VOLUME_FRAME.name(), relativeMetadata.getScreenVolumeFrame(),         false);
174         generator.writeEntry(CdmRelativeMetadataKey.SCREEN_VOLUME_SHAPE.name(), relativeMetadata.getScreenVolumeShape(),         false);
175         generator.writeEntry(CdmRelativeMetadataKey.SCREEN_VOLUME_X.name(),     relativeMetadata.getScreenVolumeX(), Unit.METRE, false);
176         generator.writeEntry(CdmRelativeMetadataKey.SCREEN_VOLUME_Y.name(),     relativeMetadata.getScreenVolumeY(), Unit.METRE, false);
177         generator.writeEntry(CdmRelativeMetadataKey.SCREEN_VOLUME_Z.name(),     relativeMetadata.getScreenVolumeZ(), Unit.METRE, false);
178         generator.writeEntry(CdmRelativeMetadataKey.SCREEN_ENTRY_TIME.name(),   getTimeConverter(),
179                              relativeMetadata.getScreenEntryTime(), true, false);
180         generator.writeEntry(CdmRelativeMetadataKey.SCREEN_EXIT_TIME.name(),    getTimeConverter(),
181                              relativeMetadata.getScreenExitTime(), true, false);
182         generator.writeEntry(CdmRelativeMetadataKey.COLLISION_PROBABILITY.name(), relativeMetadata.getCollisionProbability(), Unit.ONE, false);
183         if (relativeMetadata.getCollisionProbaMethod() != null)  {
184             generator.writeEntry(CdmRelativeMetadataKey.COLLISION_PROBABILITY_METHOD.name(),
185                                  relativeMetadata.getCollisionProbaMethod().getName(), null, false);
186         }
187 
188         // stop relative metadata block
189         if (generator.getFormat() == FileFormat.XML) {
190             generator.exitSection();
191         }
192 
193     }
194 
195 }
196