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

Class OcmParser

java.lang.Object

org.orekit.files.ccsds.utils.parsing.AbstractMessageParser<T>

org.orekit.files.ccsds.utils.parsing.AbstractConstituentParser<T,P>

org.orekit.files.ccsds.ndm.odm.OdmParser<Ocm,OcmParser>

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

All Implemented Interfaces:

MessageParser<Ocm>, EphemerisFileParser<Ocm>

public class OcmParser
extends OdmParser<Ocm,OcmParser>
implements EphemerisFileParser<Ocm>

A parser for the CCSDS OCM (Orbit Comprehensive Message).

Note than starting with Orekit 11.0, CCSDS message parsers are mutable objects that gather the data being parsed, until the message is complete and the parseMessage method has returned. This implies that parsers should not be used in a multi-thread context. The recommended way to use parsers is to either dedicate one parser for each message and drop it afterwards, or to use a single-thread loop.

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor and Description
OcmParser(IERSConventions conventions, boolean simpleEOP, DataContext dataContext, double mu, ParsedUnitsBehavior parsedUnitsBehavior) Complete constructor.

Method Summary

Modifier and Type	Method and Description
Ocm	build() Build the file from parsed entries.
boolean	finalizeData() Finalize data after parsing.
boolean	finalizeHeader() Finalize header after parsing.
boolean	finalizeMetadata() Finalize metadata after parsing.
Header	getHeader() Get file header to fill.
Map<String,XmlTokenBuilder>	getSpecialXmlElementsBuilders() Get the non-default token builders for special XML elements.
boolean	inData() Acknowledge data parsing has started.
boolean	inHeader() Acknowledge header parsing has started.
boolean	inMetadata() Acknowledge metada parsing has started.
Ocm	parse(DataSource source) Parse an ephemeris file from a data source.
boolean	prepareData() Prepare data for parsing.
boolean	prepareHeader() Prepare header for parsing.
boolean	prepareMetadata() Prepare metadata for parsing.
void	reset(FileFormat fileFormat) Reset parser to initial state before parsing.

Methods inherited from class org.orekit.files.ccsds.ndm.odm.OdmParser

getMissionReferenceDate, getMuSet, getSelectedMu, setMuCreated, setMuParsed

Methods inherited from class org.orekit.files.ccsds.utils.parsing.AbstractConstituentParser

getConventions, getDataContext, getParsedUnitsBehavior, isSimpleEOP

Methods inherited from class org.orekit.files.ccsds.utils.parsing.AbstractMessageParser

anticipateNext, getCurrent, getFileFormat, getFormatVersionKey, parseMessage, process, reset, setEndTagSeen, setFallback, wasEndTagSeen

Methods inherited from class java.lang.Object

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

Constructor Detail

OcmParser

public OcmParser(IERSConventions conventions,
                 boolean simpleEOP,
                 DataContext dataContext,
                 double mu,
                 ParsedUnitsBehavior parsedUnitsBehavior)

Complete constructor.

Calling this constructor directly is not recommended. Users should rather use parserBuilder.buildOcmParser().

Parameters:

conventions - IERS Conventions

simpleEOP - if true, tidal effects are ignored when interpolating EOP

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

mu - gravitational coefficient

parsedUnitsBehavior - behavior to adopt for handling parsed units

Method Detail

getSpecialXmlElementsBuilders

public Map<String,XmlTokenBuilder> getSpecialXmlElementsBuilders()

Get the non-default token builders for special XML elements.

Specified by:

getSpecialXmlElementsBuilders in interface MessageParser<Ocm>

Overrides:

getSpecialXmlElementsBuilders in class AbstractMessageParser<Ocm>

Returns:

map of token builders for special XML elements (keyed by XML element name)

parse

public Ocm parse(DataSource source)

Parse an ephemeris file from a data source.

Specified by:

parse in interface EphemerisFileParser<Ocm>

Parameters:

source - source providing the data to parse

Returns:

a parsed ephemeris file.

getHeader

public Header getHeader()

Get file header to fill.

Specified by:

getHeader in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

file header to fill

reset

public void reset(FileFormat fileFormat)

Reset parser to initial state before parsing.

Specified by:

reset in interface MessageParser<Ocm>

Parameters:

fileFormat - format of the file ready to be parsed

prepareHeader

public boolean prepareHeader()

Prepare header for parsing.

Specified by:

prepareHeader in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

inHeader

public boolean inHeader()

Acknowledge header parsing has started.

Specified by:

inHeader in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

finalizeHeader

public boolean finalizeHeader()

Finalize header after parsing.

Specified by:

finalizeHeader in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

prepareMetadata

public boolean prepareMetadata()

Prepare metadata for parsing.

Specified by:

prepareMetadata in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

inMetadata

public boolean inMetadata()

Acknowledge metada parsing has started.

Specified by:

inMetadata in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

finalizeMetadata

public boolean finalizeMetadata()

Finalize metadata after parsing.

Specified by:

finalizeMetadata in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

prepareData

public boolean prepareData()

Prepare data for parsing.

Specified by:

prepareData in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

inData

public boolean inData()

Acknowledge data parsing has started.

Specified by:

inData in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

finalizeData

public boolean finalizeData()

Finalize data after parsing.

Specified by:

finalizeData in class AbstractConstituentParser<Ocm,OcmParser>

Returns:

true if parser was able to perform the action

build

public Ocm build()

Build the file from parsed entries.

Specified by:

build in interface MessageParser<Ocm>

Returns:

parsed file