org.orekit.files.ccsds

Class OEMWriter

java.lang.Object

org.orekit.files.ccsds.OEMWriter

All Implemented Interfaces:

EphemerisFileWriter

public class OEMWriter
extends Object
implements EphemerisFileWriter

An OEM Writer class that can take in a general EphemerisFile object and export it as a valid OEM file.

Since:

9.0

Author:

Hank Grabowski, Evan Ward

See Also:

CCSDS 502.0-B-2 Orbit Data Messages, CCSDS 500.0-G-4 Navigation Data Definitions and Conventions, StreamingOemWriter

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OEMWriter.InterpolationMethod OEM interpolation method.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CCSDS_OEM_VERS Version number implemented.
static OEMWriter.InterpolationMethod	DEFAULT_INTERPOLATION_METHOD Default interpolation method if the user specifies none.
static String	DEFAULT_ORIGINATOR Default originator field value if user specifies none.

Constructor Summary

Constructors

Constructor and Description
OEMWriter() Standard default constructor that creates a writer with default configurations.
OEMWriter(OEMWriter.InterpolationMethod interpolationMethod, String originator, String spaceObjectId, String spaceObjectName) Constructor used to create a new OEM writer configured with the necessary parameters to successfully fill in all required fields that aren't part of a standard EphemerisFile object and using default formatting for position and velocity ephemeris data output.
OEMWriter(OEMWriter.InterpolationMethod interpolationMethod, String originator, String spaceObjectId, String spaceObjectName, String positionFormat, String velocityFormat) Constructor used to create a new OEM writer configured with the necessary parameters to successfully fill in all required fields that aren't part of a standard EphemerisFile object and user-defined position and velocity ephemeris data output format.

Method Summary

Modifier and Type	Method and Description
void	write(Appendable writer, EphemerisFile 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

Field Detail

CCSDS_OEM_VERS

public static final String CCSDS_OEM_VERS

Version number implemented.

See Also:

Constant Field Values

DEFAULT_INTERPOLATION_METHOD

public static final OEMWriter.InterpolationMethod DEFAULT_INTERPOLATION_METHOD

Default interpolation method if the user specifies none.

DEFAULT_ORIGINATOR

public static final String DEFAULT_ORIGINATOR

Default originator field value if user specifies none.

See Also:

Constant Field Values

Constructor Detail

OEMWriter

public OEMWriter()

Standard default constructor that creates a writer with default configurations.

OEMWriter

public OEMWriter(OEMWriter.InterpolationMethod interpolationMethod,
                 String originator,
                 String spaceObjectId,
                 String spaceObjectName)

Constructor used to create a new OEM writer configured with the necessary parameters to successfully fill in all required fields that aren't part of a standard EphemerisFile object and using default formatting for position and velocity ephemeris data output.

Parameters:

interpolationMethod - the interpolation method to specify in the OEM file

originator - the originator field string

spaceObjectId - the spacecraft ID

spaceObjectName - the space object common name

OEMWriter

public OEMWriter(OEMWriter.InterpolationMethod interpolationMethod,
                 String originator,
                 String spaceObjectId,
                 String spaceObjectName,
                 String positionFormat,
                 String velocityFormat)

Constructor used to create a new OEM writer configured with the necessary parameters to successfully fill in all required fields that aren't part of a standard EphemerisFile object and user-defined position and velocity ephemeris data output format.

Parameters:

interpolationMethod - the interpolation method to specify in the OEM file

originator - the originator field string

spaceObjectId - the spacecraft ID

spaceObjectName - the space object common name

positionFormat - format parameters for position ephemeris data output

velocityFormat - format parameters for velocity ephemeris data output

Method Detail

write

public void write(Appendable writer,
                  EphemerisFile ephemerisFile)
           throws IOException

Write the passed in EphemerisFile using the passed in Appendable.

Specified by:

write in interface EphemerisFileWriter

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