public class OMMParser extends ODMParser
Constructor and Description |
---|
OMMParser()
Simple constructor.
|
OMMParser(DataContext dataContext)
Constructor with data context.
|
Modifier and Type | Method and Description |
---|---|
OMMFile |
parse(InputStream stream)
Parse a CCSDS Orbit Data Message.
|
OMMFile |
parse(InputStream stream,
String fileName)
Parse a CCSDS Orbit Data Message.
|
OMMFile |
parse(String fileName)
Parse a CCSDS Orbit Data Message.
|
OMMParser |
withConventions(IERSConventions newConventions)
Set IERS conventions.
|
OMMParser |
withDataContext(DataContext newDataContext)
Set the data context.
|
OMMParser |
withInternationalDesignator(int newLaunchYear,
int newLaunchNumber,
String newLaunchPiece)
Set international designator.
|
OMMParser |
withMissionReferenceDate(AbsoluteDate newMissionReferenceDate)
Set initial date.
|
OMMParser |
withMu(double newMu)
Set gravitational coefficient.
|
OMMParser |
withSimpleEOP(boolean newSimpleEOP)
Set EOP interpolation method.
|
getConventions, getDataContext, getLaunchNumber, getLaunchPiece, getLaunchYear, getMissionReferenceDate, getMu, isSimpleEOP, parseCCSDSFrame, parseComment, parseDate, parseGeneralStateDataEntry, parseHeaderEntry, parseMetaDataEntry
@DefaultDataContext public OMMParser()
This class is immutable, and hence thread safe. When parts
must be changed, such as reference date for Mission Elapsed Time or
Mission Relative Time time systems, or the gravitational coefficient or
the IERS conventions, the various withXxx
methods must be called,
which create a new immutable instance with the new parameters. This
is a combination of the
builder design
pattern and a
fluent
interface.
The initial date for Mission Elapsed Time and Mission Relative Time time systems is not set here.
If such time systems are used, it must be initialized before parsing by calling withMissionReferenceDate(AbsoluteDate)
.
The gravitational coefficient is not set here. If it is needed in order
to parse Cartesian orbits where the value is not set in the CCSDS file, it must
be initialized before parsing by calling withMu(double)
.
The IERS conventions to use is not set here. If it is needed in order to
parse some reference frames or UT1 time scale, it must be initialized before
parsing by calling withConventions(IERSConventions)
.
The international designator parameters (launch year, launch number and
launch piece) are not set here. If they are needed, they must be initialized before
parsing by calling withInternationalDesignator(int, int, String)
This method uses the default data context
. See
withDataContext(DataContext)
.
public OMMParser(DataContext dataContext)
This class is immutable, and hence thread safe. When parts
must be changed, such as reference date for Mission Elapsed Time or
Mission Relative Time time systems, or the gravitational coefficient or
the IERS conventions, the various withXxx
methods must be called,
which create a new immutable instance with the new parameters. This
is a combination of the
builder design
pattern and a
fluent
interface.
The initial date for Mission Elapsed Time and Mission Relative Time time systems is not set here.
If such time systems are used, it must be initialized before parsing by calling withMissionReferenceDate(AbsoluteDate)
.
The gravitational coefficient is not set here. If it is needed in order
to parse Cartesian orbits where the value is not set in the CCSDS file, it must
be initialized before parsing by calling withMu(double)
.
The IERS conventions to use is not set here. If it is needed in order to
parse some reference frames or UT1 time scale, it must be initialized before
parsing by calling withConventions(IERSConventions)
.
The international designator parameters (launch year, launch number and
launch piece) are not set here. If they are needed, they must be initialized before
parsing by calling withInternationalDesignator(int, int, String)
dataContext
- used by the parser.OMMParser()
,
withDataContext(DataContext)
public OMMParser withMissionReferenceDate(AbsoluteDate newMissionReferenceDate)
withMissionReferenceDate
in class ODMParser
newMissionReferenceDate
- mission reference date to use while parsingODMParser.getMissionReferenceDate()
public OMMParser withMu(double newMu)
withMu
in class ODMParser
newMu
- gravitational coefficient to use while parsingODMParser.getMu()
public OMMParser withConventions(IERSConventions newConventions)
withConventions
in class ODMParser
newConventions
- IERS conventions to use while parsingODMParser.getConventions()
public OMMParser withSimpleEOP(boolean newSimpleEOP)
withSimpleEOP
in class ODMParser
newSimpleEOP
- if true, tidal effects are ignored when interpolating EOPODMParser.isSimpleEOP()
public OMMParser withInternationalDesignator(int newLaunchYear, int newLaunchNumber, String newLaunchPiece)
This method may be used to ensure the launch year number and pieces are correctly set if they are not present in the CCSDS file header in the OBJECT_ID in the form YYYY-NNN-P{PP}. If they are already in the header, they will be parsed automatically regardless of this method being called or not (i.e. header information override information set here).
withInternationalDesignator
in class ODMParser
newLaunchYear
- launch yearnewLaunchNumber
- launch numbernewLaunchPiece
- piece of launch (from "A" to "ZZZ")public OMMParser withDataContext(DataContext newDataContext)
ODMParser
withDataContext
in class ODMParser
newDataContext
- used for frames, time scales, and celestial bodies.public OMMFile parse(InputStream stream)
public OMMFile parse(InputStream stream, String fileName)
Copyright © 2002-2020 CS Group. All rights reserved.