Package org.orekit.files.general

Class OrekitEphemerisFile.OrekitEphemerisSegment

java.lang.Object

org.orekit.files.general.OrekitEphemerisFile.OrekitEphemerisSegment

All Implemented Interfaces:

EphemerisFile.EphemerisSegment<TimeStampedPVCoordinates>

Enclosing class:

OrekitEphemerisFile

public static class OrekitEphemerisFile.OrekitEphemerisSegment
extends Object
implements EphemerisFile.EphemerisSegment<TimeStampedPVCoordinates>

Ephemeris segment.

Constructor Summary

Constructors

Constructor	Description
OrekitEphemerisSegment(List<TimeStampedPVCoordinates> coordinates, Frame frame, double mu, int interpolationSamples)	constructor for OrekitEphemerisSegment.

Method Summary

Modifier and Type	Method	Description
CartesianDerivativesFilter	getAvailableDerivatives()	Get which derivatives of position are available in this ephemeris segment.
List<TimeStampedPVCoordinates>	getCoordinates()	Get the coordinates for this ephemeris segment in EphemerisFile.EphemerisSegment.getFrame().
Frame	getFrame()	Get the reference frame for this ephemeris segment.
Frame	getInertialFrame()	Get the inertial reference 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.

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, getPropagator

Constructor Detail

OrekitEphemerisSegment

public OrekitEphemerisSegment(List<TimeStampedPVCoordinates> coordinates,
                              Frame frame,
                              double mu,
                              int interpolationSamples)

constructor for OrekitEphemerisSegment.

Parameters:

coordinates - coordinates making up the ephemeris for this segment

frame - the frame the coordinates are in

mu - the gravitational constant used in force model evaluations

interpolationSamples - the number of samples to use during interpolation

Method Detail

getMu

public double getMu()

Get the standard gravitational parameter for the satellite.

Specified by:

getMu in interface EphemerisFile.EphemerisSegment<TimeStampedPVCoordinates>

Returns:

the gravitational parameter used in EphemerisFile.EphemerisSegment.getPropagator(AttitudeProvider), in m³/s².

getFrame

public Frame getFrame()

Get the reference frame for this ephemeris segment. The defining frame for EphemerisFile.EphemerisSegment.getCoordinates().

Specified by:

getFrame in interface EphemerisFile.EphemerisSegment<TimeStampedPVCoordinates>

Returns:

the reference frame for this segment. Never null.

getInertialFrame

public Frame getInertialFrame()

Get the inertial reference frame for this ephemeris segment. Defines the propagation frame for EphemerisFile.EphemerisSegment.getPropagator(AttitudeProvider).

The default implementation returns EphemerisFile.EphemerisSegment.getFrame() if it is inertial. Otherwise it returns Frame.getRoot(). Implementors are encouraged to override this default implementation if a more suitable inertial frame is available.

Specified by:

getInertialFrame in interface EphemerisFile.EphemerisSegment<TimeStampedPVCoordinates>

Returns:

an reference frame that is inertial, i.e. Frame.isPseudoInertial() is true. May be the same as EphemerisFile.EphemerisSegment.getFrame() if it is inertial.

getInterpolationSamples

public int getInterpolationSamples()

Get the number of samples to use in interpolation.

Specified by:

getInterpolationSamples in interface EphemerisFile.EphemerisSegment<TimeStampedPVCoordinates>

Returns:

the number of points to use for interpolation.

getAvailableDerivatives

public CartesianDerivativesFilter getAvailableDerivatives()

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<TimeStampedPVCoordinates>

Returns:

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

getCoordinates

public List<TimeStampedPVCoordinates> getCoordinates()

Get the coordinates for this ephemeris segment in EphemerisFile.EphemerisSegment.getFrame().

Specified by:

getCoordinates in interface EphemerisFile.EphemerisSegment<TimeStampedPVCoordinates>

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

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<TimeStampedPVCoordinates>

Returns:

ephemeris segment start date.

getStop

public AbsoluteDate getStop()

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<TimeStampedPVCoordinates>

Returns:

ephemeris segment end date.