org.orekit.files.general

Interface EphemerisFileWriter

All Known Implementing Classes:

CPFWriter, EphemerisWriter

public interface EphemerisFileWriter

An interface for writing out ephemeris files to disk.

An EphemerisFile consists of one or more satellites each an ID unique within the file. The ephemeris for each satellite consists of one or more segments.

Ephemeris file formats may have additional settings that need to be configured to be compliant with their formats.

Since:

9.0

Author:

Hank Grabowski

Method Summary

Modifier and Type	Method and Description
<C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>> void	write(Appendable writer, EphemerisFile<C,S> ephemerisFile) Write the passed in EphemerisFile using the passed in Appendable.
default <C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>> void	write(String outputFilePath, EphemerisFile<C,S> ephemerisFile) Write the passed in EphemerisFile to a file at the output path specified.

Method Detail

write

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

Write the passed in EphemerisFile using the passed in Appendable.

Type Parameters:

C - type of the Cartesian coordinates

S - type of the segment

Parameters:

writer - 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.)

write

default <C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>> void write(String outputFilePath,
                                                                                                    EphemerisFile<C,S> ephemerisFile)
                                                                                             throws IOException

Write the passed in EphemerisFile to a file at the output path specified.

Type Parameters:

C - type of the Cartesian coordinates

S - type of the segment

Parameters:

outputFilePath - a file path that the corresponding file will be written to

ephemerisFile - a populated ephemeris file to serialize into the buffer

Throws:

IOException - if any file 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.)