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

Class OcmWriter

java.lang.Object

org.orekit.files.ccsds.utils.generation.AbstractMessageWriter<OdmHeader,Segment<OcmMetadata,OcmData>,Ocm>

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

All Implemented Interfaces:

MessageWriter<OdmHeader,Segment<OcmMetadata,OcmData>,Ocm>

public class OcmWriter
extends AbstractMessageWriter<OdmHeader,Segment<OcmMetadata,OcmData>,Ocm>

Writer for CCSDS Orbit Comprehensive Message.

Since:

11.0

Author:

Luc Maisonobe

See Also:

EphemerisOcmWriter, StreamingOcmWriter

Field Summary

Fields

Modifier and Type	Field	Description
static double	CCSDS_OCM_VERS	Version number implemented.
static int	KVN_PADDING_WIDTH	Padding width for aligning the '=' sign.

Fields inherited from class org.orekit.files.ccsds.utils.generation.AbstractMessageWriter

DEFAULT_ORIGINATOR

Constructor Summary

Constructors

Constructor	Description
OcmWriter(IERSConventions conventions, double equatorialRadius, double flattening, DataContext dataContext)	Complete constructor.

Method Summary

Modifier and Type	Method	Description
double	getEquatorialRadius()	Get the central body equatorial radius.
double	getFlattening()	Get the central body flattening.
protected void	writeSegmentContent(Generator generator, double formatVersion, Segment<OcmMetadata,OcmData> segment)	Write one segment content (without XML wrapping).

Methods inherited from class org.orekit.files.ccsds.utils.generation.AbstractMessageWriter

getContext, getDefaultVersion, getFormatVersionKey, getRoot, getTimeConverter, getVersion, setContext, writeFooter, writeHeader, writeSegment

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.ccsds.utils.generation.MessageWriter

writeMessage

Field Detail

CCSDS_OCM_VERS

public static final double CCSDS_OCM_VERS

Version number implemented.

See Also:

Constant Field Values

KVN_PADDING_WIDTH

public static final int KVN_PADDING_WIDTH

Padding width for aligning the '=' sign.

See Also:

Constant Field Values

Constructor Detail

OcmWriter

public OcmWriter(IERSConventions conventions,
                 double equatorialRadius,
                 double flattening,
                 DataContext dataContext)

Complete constructor.

Calling this constructor directly is not recommended. Users should rather use writerBuilder.buildOcmWriter().

Parameters:

conventions - IERS Conventions

equatorialRadius - central body equatorial radius

flattening - central body flattening

dataContext - used to retrieve frames, time scales, etc.

Method Detail

getEquatorialRadius

public double getEquatorialRadius()

Get the central body equatorial radius.

Returns:

central body equatorial radius

Since:

12.0

getFlattening

public double getFlattening()

Get the central body flattening.

Returns:

central body flattening

Since:

12.0

writeSegmentContent

protected void writeSegmentContent(Generator generator,
                                   double formatVersion,
                                   Segment<OcmMetadata,OcmData> segment)
                            throws IOException

Write one segment content (without XML wrapping).

Specified by:

writeSegmentContent in class AbstractMessageWriter<OdmHeader,Segment<OcmMetadata,OcmData>,Ocm>

Parameters:

generator - generator to use for producing output

formatVersion - format version to use

segment - segment to write

Throws:

IOException - if any buffer writing operations fails