Package org.orekit.files.ccsds.ndm.odm.ocm

Class EphemerisOcmWriter

java.lang.Object

org.orekit.files.ccsds.ndm.odm.ocm.EphemerisOcmWriter

All Implemented Interfaces:

EphemerisFileWriter

public class EphemerisOcmWriter
extends Object
implements EphemerisFileWriter

An EphemerisFileWriter generating OCM files.

This writer is intended to write only trajectory state history blocks. It does not writes physical properties, covariance data, maneuver data, perturbations parameters, orbit determination or user-defined parameters. If these blocks are needed, then OcmWriter must be used as it handles all OCM data blocks.

The trajectory blocks metadata identifiers (TRAJ_ID, TRAJ_PREV_ID, TRAJ_NEXT_ID) are updated automatically using TrajectoryStateHistoryMetadata.incrementTrajID(String), so users should generally only set TrajectoryStateHistoryMetadata.setTrajID(String) in the template.

Since:

12.0

Author:

Luc Maisonobe

See Also:

OcmWriter, StreamingOcmWriter

Constructor Summary

Constructors

Constructor	Description
EphemerisOcmWriter(OcmWriter writer, OdmHeader header, OcmMetadata metadata, TrajectoryStateHistoryMetadata template, FileFormat fileFormat, String outputName, double maxRelativeOffset, int unitsColumn)	Constructor used to create a new OCM writer configured with the necessary parameters to successfully fill in all required fields that aren't part of a standard object.

Method Summary

Modifier and Type	Method	Description
<C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>> void	write(Appendable appendable, EphemerisFile<C,S> ephemerisFile)	Write the passed in EphemerisFile using the passed in Appendable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.orekit.files.general.EphemerisFileWriter

write

Constructor Detail

EphemerisOcmWriter

public EphemerisOcmWriter(OcmWriter writer,
                          OdmHeader header,
                          OcmMetadata metadata,
                          TrajectoryStateHistoryMetadata template,
                          FileFormat fileFormat,
                          String outputName,
                          double maxRelativeOffset,
                          int unitsColumn)

Constructor used to create a new OCM writer configured with the necessary parameters to successfully fill in all required fields that aren't part of a standard object.

If the mandatory header entries are not present (or if header is null), built-in defaults will be used

The writer is built from the complete header and partial metadata. The template metadata is used to initialize and independent local copy, that will be updated as new segments are written (with at least the segment start and stop will change, but some other parts may change too). The template argument itself is not changed.

Parameters:

writer - underlying writer

header - file header (may be null)

metadata - file metadata

template - template for trajectory metadata

fileFormat - file format to use

outputName - output name for error messages

maxRelativeOffset - maximum offset in seconds to use relative dates (if a date is too far from reference, it will be displayed as calendar elements)

unitsColumn - columns number for aligning units (if negative or zero, units are not output)

Method Detail

write

public <C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>> void write(Appendable appendable,
                                                                                                         EphemerisFile<C,S> ephemerisFile)
                                                                                                  throws IOException

Write the passed in EphemerisFile using the passed in Appendable.

As EphemerisFile.SatelliteEphemeris does not have all the entries from OcmMetadata, the only values that will be extracted from the ephemerisFile will be the start time, stop time, reference frame, interpolation method and interpolation degree. The missing values (like object name, local spacecraft body frame...) will be inherited from the template metadata set at writer construction.

Specified by:

write in interface EphemerisFileWriter

Type Parameters:

C - type of the Cartesian coordinates

S - type of the segment

Parameters:

appendable - a configured Appendable to feed with text

ephemerisFile - a populated ephemeris file to serialize into the buffer

Throws:

IOException - if any buffer writing operations fail or if the underlying format doesn't support a configuration in the EphemerisFile (for example having multiple satellites in one file, having the origin at an unspecified celestial body, etc.)