org.orekit.files.ccsds.ndm

Class ParserBuilder

java.lang.Object

org.orekit.files.ccsds.ndm.AbstractBuilder<ParserBuilder>

org.orekit.files.ccsds.ndm.ParserBuilder

public class ParserBuilder
extends AbstractBuilder<ParserBuilder>

Builder for all CCSDS Message files parsers.

This builder can be used for building all CCSDS Messages parsers types. It is particularly useful in multi-threaded context as parsers cannot be shared between threads and thus several independent parsers must be built in this case.

Since:

11.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor and Description
ParserBuilder() Simple constructor.
ParserBuilder(DataContext dataContext) Simple constructor.

Method Summary

Modifier and Type	Method and Description
AemParser	buildAemParser() Build a parser for Attitude Ephemeris Messages.
ApmParser	buildApmParser() Build a parser for Attitude Parameters Messages.
NdmParser	buildNdmParser() Build a parser for Navigation Data Messages.
OcmParser	buildOcmParser() Build a parser for Orbit Comprehensive Messages.
OemParser	buildOemParser() Build a parser for Orbit Ephemeris Messages.
OmmParser	buildOmmParser() Build a parser for Orbit Mean elements Messages.
OpmParser	buildOpmParser() Build a parser for Orbit Parameters Messages.
TdmParser	buildTdmParser() Build a parser for Tracking Data Messages.
protected ParserBuilder	create(IERSConventions newConventions, DataContext newDataContext, AbsoluteDate newMissionReferenceDate, RangeUnitsConverter newRangeUnitsConverter) Build an instance.
int	getDefaultInterpolationDegree() Get the default interpolation degree.
double	getDefaultMass() Get the default mass.
double	getMu() Get the gravitational coefficient.
ParsedUnitsBehavior	getParsedUnitsBehavior() Get the behavior to adopt for handling parsed units.
boolean	isSimpleEOP() Check if tidal effects are ignored when interpolating EOP.
ParserBuilder	withDefaultInterpolationDegree(int newDefaultInterpolationDegree) Set up the default interpolation degree.
ParserBuilder	withDefaultMass(double newDefaultMass) Set up the default mass.
ParserBuilder	withMu(double newMu) Set up the gravitational coefficient.
ParserBuilder	withParsedUnitsBehavior(ParsedUnitsBehavior newParsedUnitsBehavior) Set up the behavior to adopt for handling parsed units.
ParserBuilder	withSimpleEOP(boolean newSimpleEOP) Set up flag for ignoring tidal effects when interpolating EOP.

Methods inherited from class org.orekit.files.ccsds.ndm.AbstractBuilder

getConventions, getDataContext, getMissionReferenceDate, getRangeUnitsConverter, withConventions, withDataContext, withMissionReferenceDate, withRangeUnitsConverter

Methods inherited from class java.lang.Object

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

Constructor Detail

ParserBuilder

@DefaultDataContext
public ParserBuilder()

Simple constructor.

This constructor creates a builder with

• IERS conventions set to IERSConventions.IERS_2010
• simple EOP set to true
• data context set to default context
• mission reference date set to null
• gravitational coefficient set to Double.NaN
• default mass set to Double.NaN
• default interpolation degree set to 1
• parsed unit behavior set to ParsedUnitsBehavior.CONVERT_COMPATIBLE
• converter for range units set to IdentityConverter

ParserBuilder

public ParserBuilder(DataContext dataContext)

Simple constructor.

This constructor creates a builder with

• IERS conventions set to IERSConventions.IERS_2010
• simple EOP set to true
• mission reference date set to null
• gravitational coefficient set to Double.NaN
• default mass set to Double.NaN
• default interpolation degree set to 1
• parsed unit behavior set to ParsedUnitsBehavior.CONVERT_COMPATIBLE
• converter for range units set to IdentityConverter

Parameters:

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

Method Detail

create

protected ParserBuilder create(IERSConventions newConventions,
                               DataContext newDataContext,
                               AbsoluteDate newMissionReferenceDate,
                               RangeUnitsConverter newRangeUnitsConverter)

Build an instance.

Specified by:

create in class AbstractBuilder<ParserBuilder>

Parameters:

newConventions - IERS Conventions

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

newMissionReferenceDate - reference date for Mission Elapsed Time or Mission Relative Time time systems

newRangeUnitsConverter - converter for Range Units

Returns:

new instance

withSimpleEOP

public ParserBuilder withSimpleEOP(boolean newSimpleEOP)

Set up flag for ignoring tidal effects when interpolating EOP.

Parameters:

newSimpleEOP - true if tidal effects are ignored when interpolating EOP

Returns:

a new builder with updated configuration (the instance is not changed)

isSimpleEOP

public boolean isSimpleEOP()

Check if tidal effects are ignored when interpolating EOP.

Returns:

true if tidal effects are ignored when interpolating EOP

withMu

public ParserBuilder withMu(double newMu)

Set up the gravitational coefficient.

Parameters:

newMu - gravitational coefficient

Returns:

a new builder with updated configuration (the instance is not changed)

getMu

public double getMu()

Get the gravitational coefficient.

Returns:

gravitational coefficient

withDefaultMass

public ParserBuilder withDefaultMass(double newDefaultMass)

Set up the default mass.

The default mass is used only by OpmParser.

Parameters:

newDefaultMass - default mass

Returns:

a new builder with updated configuration (the instance is not changed)

getDefaultMass

public double getDefaultMass()

Get the default mass.

Returns:

default mass

withDefaultInterpolationDegree

public ParserBuilder withDefaultInterpolationDegree(int newDefaultInterpolationDegree)

Set up the default interpolation degree.

The default interpolation degree is used only by AemParser and OemParser.

Parameters:

newDefaultInterpolationDegree - default interpolation degree

Returns:

a new builder with updated configuration (the instance is not changed)

getDefaultInterpolationDegree

public int getDefaultInterpolationDegree()

Get the default interpolation degree.

Returns:

default interpolation degree

withParsedUnitsBehavior

public ParserBuilder withParsedUnitsBehavior(ParsedUnitsBehavior newParsedUnitsBehavior)

Set up the behavior to adopt for handling parsed units.

Parameters:

newParsedUnitsBehavior - behavior to adopt for handling parsed units

Returns:

a new builder with updated configuration (the instance is not changed)

getParsedUnitsBehavior

public ParsedUnitsBehavior getParsedUnitsBehavior()

Get the behavior to adopt for handling parsed units.

Returns:

behavior to adopt for handling parsed units

buildNdmParser

public NdmParser buildNdmParser()

Build a parser for Navigation Data Messages.

Returns:

a new parser

buildOpmParser

public OpmParser buildOpmParser()

Build a parser for Orbit Parameters Messages.

Returns:

a new parser

buildOmmParser

public OmmParser buildOmmParser()

Build a parser for Orbit Mean elements Messages.

Returns:

a new parser

buildOemParser

public OemParser buildOemParser()

Build a parser for Orbit Ephemeris Messages.

Returns:

a new parser

buildOcmParser

public OcmParser buildOcmParser()

Build a parser for Orbit Comprehensive Messages.

Returns:

a new parser

buildApmParser

public ApmParser buildApmParser()

Build a parser for Attitude Parameters Messages.

Returns:

a new parser

buildAemParser

public AemParser buildAemParser()

Build a parser for Attitude Ephemeris Messages.

Returns:

a new parser

buildTdmParser

public TdmParser buildTdmParser()

Build a parser for Tracking Data Messages.

Returns:

a new parser