Package org.orekit.files.ccsds.ndm.adm.aem

Class AttitudeWriter

java.lang.Object
org.orekit.files.ccsds.ndm.adm.aem.AttitudeWriter
All Implemented Interfaces:
AttitudeEphemerisFileWriter
public class AttitudeWriter extends Object implements AttitudeEphemerisFileWriter
An AttitudeEphemerisFileWriter generating AEM files.
Since:
11.0
Author:
Bryan Cazabonne

  • Constructor Details

    • AttitudeWriter

      public AttitudeWriter(AemWriter writer, AdmHeader header, AemMetadata template, FileFormat fileFormat, String outputName, double maxRelativeOffset, int unitsColumn, Formatter formatter)
      Constructor used to create a new AEM 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.

      Calling this constructor directly is not recommended. Users should rather use WriterBuilder.buildAemWriter().

      Parameters:
      writer - underlying writer
      header - file header (may be null)
      template - template for 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)
      formatter - how to format date and double to string.
      Since:
      13.0

    • AttitudeWriter

      public AttitudeWriter(AemWriter writer, AdmHeader header, AemMetadata template, FileFormat fileFormat, String outputName, double maxRelativeOffset, int unitsColumn)
      Constructor used to create a new AEM 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.

      Calling this constructor directly is not recommended. Users should rather use WriterBuilder.buildAemWriter().

      Parameters:
      writer - underlying writer
      header - file header (may be null)
      template - template for 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)
      Since:
      12.0

  • Method Details

    • write

      public <C extends TimeStampedAngularCoordinates, S extends AttitudeEphemerisFile.AttitudeEphemerisSegment<C>> void write(Appendable appendable, AttitudeEphemerisFile<C,S> ephemerisFile) throws IOException
      Write the passed in AttitudeEphemerisFile using the passed in Appendable.

      As AttitudeEphemerisFile.SatelliteAttitudeEphemeris does not have all the entries from AemMetadata, 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, attitude type...) will be inherited from the template metadata set at writer construction.

      Specified by:
      write in interface AttitudeEphemerisFileWriter
      Type Parameters:
      C - type of the angular 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.)