org.orekit.files.ccsds.ndm.adm.apm

Class Apm

java.lang.Object

org.orekit.files.ccsds.ndm.NdmConstituent<Header,Segment<AdmMetadata,ApmData>>

org.orekit.files.ccsds.ndm.adm.apm.Apm

public class Apm
extends NdmConstituent<Header,Segment<AdmMetadata,ApmData>>

This class stores all the information of the Attitude Parameter Message (APM) File parsed by APMParser. It contains the header and the metadata and a the data lines.

Since:

10.2

Author:

Bryan Cazabonne

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORMAT_VERSION_KEY Key for format version.
static String	ROOT Root element for XML files.

Constructor Summary

Constructors

Constructor and Description
Apm(Header header, List<Segment<AdmMetadata,ApmData>> segments, IERSConventions conventions, DataContext dataContext) Simple constructor.

Method Summary

Modifier and Type	Method and Description
Attitude	getAttitude(Frame frame, PVCoordinatesProvider pvProvider) Get the attitude.
ApmData	getData() Get the file data.
AdmMetadata	getMetadata() Get the file metadata.

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

getConventions, getDataContext, getHeader, getSegments, validate

Methods inherited from class java.lang.Object

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

Field Detail

ROOT

public static final String ROOT

Root element for XML files.

See Also:

Constant Field Values

FORMAT_VERSION_KEY

public static final String FORMAT_VERSION_KEY

Key for format version.

See Also:

Constant Field Values

Constructor Detail

Apm

public Apm(Header header,
           List<Segment<AdmMetadata,ApmData>> segments,
           IERSConventions conventions,
           DataContext dataContext)

Simple constructor.

Parameters:

header - file header

segments - file segments

conventions - IERS conventions

dataContext - used for creating frames, time scales, etc.

Method Detail

getMetadata

public AdmMetadata getMetadata()

Get the file metadata.

Returns:

file metadata

getData

public ApmData getData()

Get the file data.

Returns:

file data

getAttitude

public Attitude getAttitude(Frame frame,
                            PVCoordinatesProvider pvProvider)

Get the attitude.

The orientation part of the attitude is always extracted from the file mandatory quaternion logical block. The rotation rate part of the attitude is extracted from the quaternion logical block if rate is available there, or from the Euler logical block if rate is missing from quaternion logical block but available in Euler logical block.

Parameters:

frame - reference frame with respect to which attitude must be defined, (may be null if attitude is not orbit-relative and one wants attitude in the same frame as used in the attitude message)

pvProvider - provider for spacecraft position and velocity (may be null if attitude is not orbit-relative)

Returns:

attitude