org.orekit.files.ccsds

Class OEMFile.EphemeridesBlock

java.lang.Object

org.orekit.files.ccsds.OEMFile.EphemeridesBlock

All Implemented Interfaces:

EphemerisFile.EphemerisSegment

Enclosing class:

OEMFile

public class OEMFile.EphemeridesBlock
extends Object
implements EphemerisFile.EphemerisSegment

The Ephemerides Blocks class contain metadata, the list of ephemerides data lines and optional covariance matrices (and their metadata). The reason for which the ephemerides have been separated into blocks is that the ephemerides of two different blocks are not suited for interpolation.

Author:

sports

Constructor Summary

Constructors

Constructor and Description
EphemeridesBlock() EphemeridesBlock constructor.

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 in EphemerisFile.EphemerisSegment.getFrame().
List<OEMFile.CovarianceMatrix>	getCovarianceMatrices() Get the list of Covariance Matrices.
List<String>	getEphemeridesDataLinesComment() Get the ephemerides data lines comment.
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.
boolean	getHasRefFrameEpoch() Get boolean testing whether the reference frame has an epoch associated to it.
Frame	getInertialFrame() Get the inertial reference frame for this ephemeris segment.
int	getInterpolationDegree() Get the interpolation degree.
String	getInterpolationMethod() Get the interpolation method to be used.
int	getInterpolationSamples() Get the number of samples to use in interpolation.
ODMMetaData	getMetaData() Get the meta-data for the block.
double	getMu() Get the standard gravitational parameter for the satellite.
AbsoluteDate	getStart() Get the start date of this ephemeris segment.
AbsoluteDate	getStartTime() Get start of total time span covered by ephemerides data and covariance data.
AbsoluteDate	getStop() Get the end date of this ephemeris segment.
AbsoluteDate	getStopTime() Get end of total time span covered by ephemerides data and covariance data.
TimeScale	getTimeScale() Get the time scale for this ephemeris segment.
String	getTimeScaleString() Get the time scale for this ephemeris segment.
AbsoluteDate	getUseableStartTime() Get start of useable time span covered by ephemerides data, it may be necessary to allow for proper interpolation.
AbsoluteDate	getUseableStopTime() Get end of useable time span covered by ephemerides data, it may be necessary to allow for proper interpolation.

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

EphemeridesBlock

public EphemeridesBlock()

EphemeridesBlock constructor.

Method Detail

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 in EphemerisFile.EphemerisSegment.getFrame().

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.

getCovarianceMatrices

public List<OEMFile.CovarianceMatrix> getCovarianceMatrices()

Get the list of Covariance Matrices.

Returns:

the list of Covariance Matrices

getMetaData

public ODMMetaData getMetaData()

Get the meta-data for the block.

Returns:

meta-data for the block

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

Description copied from interface: EphemerisFile.EphemerisSegment

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

Specified by:

getFrame in interface EphemerisFile.EphemerisSegment

Returns:

the reference frame for this segment. Never null.

getInertialFrame

public Frame getInertialFrame()

Description copied from interface: EphemerisFile.EphemerisSegment

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

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

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.

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

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.

getStartTime

public AbsoluteDate getStartTime()

Get start of total time span covered by ephemerides data and covariance data.

Returns:

the start time

getStopTime

public AbsoluteDate getStopTime()

Get end of total time span covered by ephemerides data and covariance data.

Returns:

the stop time

getUseableStartTime

public AbsoluteDate getUseableStartTime()

Get start of useable time span covered by ephemerides data, it may be necessary to allow for proper interpolation.

Returns:

the useable start time

getUseableStopTime

public AbsoluteDate getUseableStopTime()

Get end of useable time span covered by ephemerides data, it may be necessary to allow for proper interpolation.

Returns:

the useable stop time

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.

getInterpolationMethod

public String getInterpolationMethod()

Get the interpolation method to be used.

Returns:

the interpolation method

getInterpolationDegree

public int getInterpolationDegree()

Get the interpolation degree.

Returns:

the interpolation degree

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.

getHasRefFrameEpoch

public boolean getHasRefFrameEpoch()

Get boolean testing whether the reference frame has an epoch associated to it.

Returns:

true if the reference frame has an epoch associated to it false otherwise

getEphemeridesDataLinesComment

public List<String> getEphemeridesDataLinesComment()

Get the ephemerides data lines comment.

Returns:

the comment