org.orekit.files.ccsds.ndm.adm

Class AdmParser<T extends NdmConstituent<?,?>,P extends AbstractConstituentParser<T,?>>

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.adm.AdmParser<T,P>

Type Parameters:

T - type of the file

P - type of the parser

All Implemented Interfaces:

MessageParser<T>

Direct Known Subclasses:

AemParser, ApmParser

public abstract class AdmParser<T extends NdmConstituent<?,?>,P extends AbstractConstituentParser<T,?>>
extends AbstractConstituentParser<T,P>

Base class for Attitude Data Message parsers.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdmParser.RotationOrderConsumer Interface representing instance methods that consume otation order values.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AdmParser(String root, String formatVersionKey, IERSConventions conventions, boolean simpleEOP, DataContext dataContext, AbsoluteDate missionReferenceDate, ParsedUnitsBehavior parsedUnitsBehavior) Complete constructor.

Method Summary

Modifier and Type	Method and Description
AbsoluteDate	getMissionReferenceDate() Get reference date for Mission Elapsed Time and Mission Relative Time time systems.
Map<String,XmlTokenBuilder>	getSpecialXmlElementsBuilders() Get the non-default token builders for special XML elements.
static boolean	processRotationOrder(ParseToken sequence, AdmParser.RotationOrderConsumer consumer) Process a CCSDS Euler angles sequence as a RotationOrder.

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

finalizeData, finalizeHeader, finalizeMetadata, getConventions, getDataContext, getHeader, getParsedUnitsBehavior, inData, inHeader, inMetadata, isSimpleEOP, prepareData, prepareHeader, prepareMetadata

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

Methods inherited from interface org.orekit.files.ccsds.utils.lexical.MessageParser

build, reset

Constructor Detail

AdmParser

protected AdmParser(String root,
                    String formatVersionKey,
                    IERSConventions conventions,
                    boolean simpleEOP,
                    DataContext dataContext,
                    AbsoluteDate missionReferenceDate,
                    ParsedUnitsBehavior parsedUnitsBehavior)

Complete constructor.

Parameters:

root - root element for XML files

formatVersionKey - key for format version

conventions - IERS Conventions

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

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

missionReferenceDate - reference date for Mission Elapsed Time or Mission Relative Time time systems (may be null if time system is absolute)

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<T extends NdmConstituent<?,?>>

Overrides:

getSpecialXmlElementsBuilders in class AbstractMessageParser<T extends NdmConstituent<?,?>>

Returns:

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

getMissionReferenceDate

public AbsoluteDate getMissionReferenceDate()

Get reference date for Mission Elapsed Time and Mission Relative Time time systems.

Returns:

the reference date

processRotationOrder

public static boolean processRotationOrder(ParseToken sequence,
                                           AdmParser.RotationOrderConsumer consumer)

Process a CCSDS Euler angles sequence as a RotationOrder.

Parameters:

sequence - Euler angles sequence token

consumer - consumer of the rotation order

Returns:

always return true