org.orekit.files.ccsds

Class APMParser

java.lang.Object

org.orekit.files.ccsds.ADMParser

org.orekit.files.ccsds.APMParser

public class APMParser
extends ADMParser

A parser for the CCSDS APM (Attitude Parameter Message).

Since:

10.2

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
APMParser() Simple constructor.
APMParser(DataContext dataContext) Constructor with data context.

Method Summary

Modifier and Type	Method and Description
APMFile	parse(InputStream stream) Parse a CCSDS Attitude Data Message.
APMFile	parse(InputStream stream, String fileName) Parse a CCSDS Attitude Data Message.
APMFile	parse(String fileName) Parse a CCSDS Attitude Data Message.
APMParser	withConventions(IERSConventions newConventions) Set IERS conventions.
APMParser	withDataContext(DataContext dataContext) Set the data context.
APMParser	withInternationalDesignator(int newLaunchYear, int newLaunchNumber, String newLaunchPiece) Set international designator.
APMParser	withMissionReferenceDate(AbsoluteDate newMissionReferenceDate) Set initial date.
APMParser	withMu(double newMu) Set gravitational coefficient.
APMParser	withSimpleEOP(boolean newSimpleEOP) Set EOP interpolation method.

Methods inherited from class org.orekit.files.ccsds.ADMParser

getConventions, getDataContext, getLaunchNumber, getLaunchPiece, getLaunchYear, getMissionReferenceDate, getMu, isSimpleEOP, parseComment, parseDate, parseGeneralStateDataEntry, parseHeaderEntry, parseMetaDataEntry, toRadians

Methods inherited from class java.lang.Object

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

Constructor Detail

APMParser

@DefaultDataContext
public APMParser()

Simple constructor.

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).

This method uses the default data context. See withDataContext(DataContext).

APMParser

public APMParser(DataContext dataContext)

Constructor with data context.

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).

Parameters:

dataContext - used by the parser.

See Also:

APMParser(), withDataContext(DataContext)

Method Detail

withMissionReferenceDate

public APMParser withMissionReferenceDate(AbsoluteDate newMissionReferenceDate)

Set initial date.

Specified by:

withMissionReferenceDate in class ADMParser

Parameters:

newMissionReferenceDate - mission reference date to use while parsing

Returns:

a new instance, with mission reference date replaced

See Also:

ADMParser.getMissionReferenceDate()

withMu

public APMParser withMu(double newMu)

Set gravitational coefficient.

Specified by:

withMu in class ADMParser

Parameters:

newMu - gravitational coefficient to use while parsing

Returns:

a new instance, with gravitational coefficient date replaced

See Also:

ADMParser.getMu()

withConventions

public APMParser withConventions(IERSConventions newConventions)

Set IERS conventions.

Specified by:

withConventions in class ADMParser

Parameters:

newConventions - IERS conventions to use while parsing

Returns:

a new instance, with IERS conventions replaced

See Also:

ADMParser.getConventions()

withSimpleEOP

public APMParser withSimpleEOP(boolean newSimpleEOP)

Set EOP interpolation method.

Specified by:

withSimpleEOP in class ADMParser

Parameters:

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

Returns:

a new instance, with EOP interpolation method replaced

See Also:

ADMParser.isSimpleEOP()

withInternationalDesignator

public APMParser withInternationalDesignator(int newLaunchYear,
                                             int newLaunchNumber,
                                             String newLaunchPiece)

Set international designator.

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).

Specified by:

withInternationalDesignator in class ADMParser

Parameters:

newLaunchYear - launch year

newLaunchNumber - launch number

newLaunchPiece - piece of launch (from "A" to "ZZZ")

Returns:

a new instance, with TLE settings replaced

withDataContext

public APMParser withDataContext(DataContext dataContext)

Set the data context.

Specified by:

withDataContext in class ADMParser

Parameters:

dataContext - used for frames, time scales, and celestial bodies.

Returns:

a new instance with the data context replaced.

parse

public APMFile parse(String fileName)

Parse a CCSDS Attitude Data Message.

Overrides:

parse in class ADMParser

Parameters:

fileName - name of the file containing the message

Returns:

parsed ADM file

parse

public APMFile parse(InputStream stream)

Parse a CCSDS Attitude Data Message.

Overrides:

parse in class ADMParser

Parameters:

stream - stream containing message

Returns:

parsed ADM file

parse

public APMFile parse(InputStream stream,
                     String fileName)

Parse a CCSDS Attitude Data Message.

Specified by:

parse in class ADMParser

Parameters:

stream - stream containing message

fileName - name of the file containing the message (for error messages)

Returns:

parsed ADM file