org.orekit.files.general

Class OrekitEphemerisFile.OrekitEphemerisSegment

java.lang.Object

org.orekit.files.general.OrekitEphemerisFile.OrekitEphemerisSegment

All Implemented Interfaces:

EphemerisFile.EphemerisSegment

Enclosing class:

OrekitEphemerisFile

public static class OrekitEphemerisFile.OrekitEphemerisSegment
extends Object
implements EphemerisFile.EphemerisSegment

Constructor Summary

Constructors

Constructor and Description
OrekitEphemerisSegment(List<TimeStampedPVCoordinates> coordinates, Frame frame, String frameCenterString, double mu, TimeScale timeScale, int samples) constructor for OrekitEphemerisSegment.

Method Summary

Modifier and Type	Method and Description
CartesianDerivativesFilter	getAvailableDerivatives() Get which derivatives of position are available in this ephemeris segment.
List<TimeStampedPVCoordinates>	getCoordinates() Get the coordinates for this ephemeris segment.
Frame	getFrame() Get the reference frame for this ephemeris segment.
String	getFrameCenterString() Get the name of the center of the coordinate system the ephemeris is provided in.
String	getFrameString() Get the defining frame for this ephemeris segment.
int	getInterpolationSamples() Get the number of samples to use in interpolation.
double	getMu() Get the standard gravitational parameter for the satellite.
AbsoluteDate	getStart() Get the start date of this ephemeris segment.
AbsoluteDate	getStop() Get the end date of this ephemeris segment.
TimeScale	getTimeScale() Get the time scale for this ephemeris segment.
String	getTimeScaleString() Get the time scale for this ephemeris segment.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.orekit.files.general.EphemerisFile.EphemerisSegment

getPropagator

Constructor Detail

OrekitEphemerisSegment

public OrekitEphemerisSegment(List<TimeStampedPVCoordinates> coordinates,
                              Frame frame,
                              String frameCenterString,
                              double mu,
                              TimeScale timeScale,
                              int samples)

constructor for OrekitEphemerisSegment.

Parameters:

coordinates - coordinates making up the ephemeris for this segment

frame - the frame the coordinates are in

frameCenterString - the name of celestial body the frame is attached to

mu - the gravitional constant used in force model evaluations

timeScale - the time scale of these ephemeris points

samples - the number of samples to use during interpolation

Method Detail

getMu

public double getMu()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the standard gravitational parameter for the satellite.

Specified by:

getMu in interface EphemerisFile.EphemerisSegment

Returns:

the gravitational parameter use in EphemerisFile.EphemerisSegment.getPropagator(), in m^3 / s^2.

getFrameCenterString

public String getFrameCenterString()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the name of the center of the coordinate system the ephemeris is provided in. This may be a natural origin, such as the center of the Earth, another satellite, etc.

Specified by:

getFrameCenterString in interface EphemerisFile.EphemerisSegment

Returns:

the name of the frame center

getFrameString

public String getFrameString()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the defining frame for this ephemeris segment.

Specified by:

getFrameString in interface EphemerisFile.EphemerisSegment

Returns:

the frame identifier, as specified in the ephemeris file, or null if the ephemeris file does not specify a frame.

getFrame

public Frame getFrame()
               throws OrekitException

Description copied from interface: EphemerisFile.EphemerisSegment

Get the reference frame for this ephemeris segment.

Specified by:

getFrame in interface EphemerisFile.EphemerisSegment

Returns:

the reference frame for this segment. Never null.

Throws:

OrekitException - if a frame cannot be created from EphemerisFile.EphemerisSegment.getFrameString() and there is no default frame.

getTimeScaleString

public String getTimeScaleString()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the time scale for this ephemeris segment.

Specified by:

getTimeScaleString in interface EphemerisFile.EphemerisSegment

Returns:

the time scale identifier, as specified in the ephemeris file, or null if the ephemeris file does not specify a time scale.

getTimeScale

public TimeScale getTimeScale()
                       throws OrekitException

Description copied from interface: EphemerisFile.EphemerisSegment

Get the time scale for this ephemeris segment.

Specified by:

getTimeScale in interface EphemerisFile.EphemerisSegment

Returns:

the time scale for this segment. Never null.

Throws:

OrekitException - if a time scale can not be constructed based on EphemerisFile.EphemerisSegment.getTimeScaleString() and there is no default time scale.

getInterpolationSamples

public int getInterpolationSamples()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the number of samples to use in interpolation.

Specified by:

getInterpolationSamples in interface EphemerisFile.EphemerisSegment

Returns:

the number of points to use for interpolation.

getAvailableDerivatives

public CartesianDerivativesFilter getAvailableDerivatives()

Description copied from interface: EphemerisFile.EphemerisSegment

Get which derivatives of position are available in this ephemeris segment.

While EphemerisFile.EphemerisSegment.getCoordinates() always returns position, velocity, and acceleration the return value from this method indicates which of those are in the ephemeris file and are actually valid.

Specified by:

getAvailableDerivatives in interface EphemerisFile.EphemerisSegment

Returns:

a value indicating if the file contains velocity and/or acceleration data.

getCoordinates

public List<TimeStampedPVCoordinates> getCoordinates()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the coordinates for this ephemeris segment.

Specified by:

getCoordinates in interface EphemerisFile.EphemerisSegment

Returns:

a list of state vectors in chronological order. The coordinates are not necessarily evenly spaced in time. The value of EphemerisFile.EphemerisSegment.getAvailableDerivatives() indicates if the velocity or accelerations were specified in the file. Any position, velocity, or acceleration coordinates that are not specified in the ephemeris file are zero in the returned values.

getStart

public AbsoluteDate getStart()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the start date of this ephemeris segment.

The date returned by this method is equivalent to getPropagator().getMinDate().

Specified by:

getStart in interface EphemerisFile.EphemerisSegment

Returns:

ephemeris segment start date.

getStop

public AbsoluteDate getStop()

Description copied from interface: EphemerisFile.EphemerisSegment

Get the end date of this ephemeris segment.

The date returned by this method is equivalent to getPropagator().getMaxDate().

Specified by:

getStop in interface EphemerisFile.EphemerisSegment

Returns:

ephemeris segment end date.