Package org.orekit.files.ccsds.ndm.odm.ocm

Class Ocm

java.lang.Object

org.orekit.files.ccsds.ndm.NdmConstituent<OdmHeader,Segment<OcmMetadata,OcmData>>

org.orekit.files.ccsds.ndm.odm.ocm.Ocm

All Implemented Interfaces:

EphemerisFile<TimeStampedPVCoordinates,TrajectoryStateHistory>

public class Ocm
extends NdmConstituent<OdmHeader,Segment<OcmMetadata,OcmData>>
implements EphemerisFile<TimeStampedPVCoordinates,TrajectoryStateHistory>

This class gathers the informations present in the Orbit Comprehensive Message (OCM).

Since:

11.0

Author:

Luc Maisonobe

Nested Class Summary

Nested classes/interfaces inherited from interface org.orekit.files.general.EphemerisFile

EphemerisFile.EphemerisSegment<C extends TimeStampedPVCoordinates>, EphemerisFile.SatelliteEphemeris<C extends TimeStampedPVCoordinates,S extends EphemerisFile.EphemerisSegment<C>>

Field Summary

Fields

Modifier and Type	Field	Description
static String	COV_LINE	Covariance line element for XML messages.
static String	FORMAT_VERSION_KEY	Key for format version.
static String	MAN_LINE	Maneuver line element for XML messages.
static String	ROOT	Root element for XML messages.
static String	TRAJ_LINE	Trajectory line element for XML messages.
static String	UNKNOWN_OBJECT	Default name for unknown object.

Constructor Summary

Constructors

Constructor	Description
Ocm(OdmHeader header, List<Segment<OcmMetadata,OcmData>> segments, IERSConventions conventions, DataContext dataContext, double mu)	Simple constructor.

Method Summary

Modifier and Type	Method	Description
OcmData	getData()	Get the data from the single segment.
OcmMetadata	getMetadata()	Get the metadata from the single segment.
Map<String,OcmSatelliteEphemeris>	getSatellites()	Get the loaded ephemeris for each satellite in the file.

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

getConventions, getDataContext, getHeader, getSegments, setHeader, setSegments, 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 messages.

See Also:

Constant Field Values

FORMAT_VERSION_KEY

public static final String FORMAT_VERSION_KEY

Key for format version.

See Also:

Constant Field Values

TRAJ_LINE

public static final String TRAJ_LINE

Trajectory line element for XML messages.

See Also:

Constant Field Values

COV_LINE

public static final String COV_LINE

Covariance line element for XML messages.

See Also:

Constant Field Values

MAN_LINE

public static final String MAN_LINE

Maneuver line element for XML messages.

See Also:

Constant Field Values

UNKNOWN_OBJECT

public static final String UNKNOWN_OBJECT

Default name for unknown object.

See Also:

Constant Field Values

Constructor Detail

Ocm

public Ocm(OdmHeader header,
           List<Segment<OcmMetadata,OcmData>> segments,
           IERSConventions conventions,
           DataContext dataContext,
           double mu)

Simple constructor.

Parameters:

header - file header

segments - ile segments

conventions - IERS conventions

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

mu - Gravitational coefficient to use for building Cartesian/Keplerian orbits.

Method Detail

getMetadata

public OcmMetadata getMetadata()

Get the metadata from the single segment.

Returns:

metadata from the single segment

getData

public OcmData getData()

Get the data from the single segment.

Returns:

data from the single segment

getSatellites

public Map<String,OcmSatelliteEphemeris> getSatellites()

Get the loaded ephemeris for each satellite in the file.

The metadata entries checked for use as the key are the following ones, the first non-null being used. The map from OCM files always contains only one object.

• OBJECT_NAME
• INTERNATIONAL_DESIGNATOR
• OBJECT_DESIGNATOR
• the default name UNKNOWN_OBJECT for unknown objects

Specified by:

getSatellites in interface EphemerisFile<TimeStampedPVCoordinates,TrajectoryStateHistory>

Returns:

a map from the satellite's ID to the information about that satellite contained in the file.