agi.foundation.stk

Class StkEphemerisFile.Ephemeris

java.lang.Object

agi.foundation.stk.StkEphemerisFile.Ephemeris

Direct Known Subclasses:

StkEphemerisFile.EphemerisLLATimePos, StkEphemerisFile.EphemerisLLRTimePos, StkEphemerisFile.EphemerisTimePos

Enclosing class:

StkEphemerisFile

public abstract static class StkEphemerisFile.Ephemeris
extends Object

The base class for ephemeris data.

Constructor Summary

Constructors

Constructor and Description
Ephemeris()

Method Summary

Modifier and Type	Method and Description
abstract Point	createPoint() Creates a Point whose time-varying position is computed by interpolating over the ephemeris data held by this instance.
abstract StkEphemerisFile.DistanceUnit	getDistanceUnit() Gets the distance unit of the ephemeris and covariance information.
abstract TranslationalMotionInterpolator	getInterpolator() Gets the interpolator to use to interpolate this ephemeris data.
abstract String	getName() Gets the name of this ephemeris format.
abstract int	getOrder() Gets the number of derivatives in this data.
StkEphemerisFile.StkTimeFormat	getTimeFormat() Gets the time format of the ephemeris and covariance information.
abstract List<JulianDate>	getTimes() Gets the times of the data points.
abstract void	setInterpolator(TranslationalMotionInterpolator value) Sets the interpolator to use to interpolate this ephemeris data.
void	setTimeFormat(StkEphemerisFile.StkTimeFormat value) Sets the time format of the ephemeris and covariance information.

Methods inherited from class java.lang.Object

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

Constructor Detail

Ephemeris

public Ephemeris()

Method Detail

getName

@Nonnull
public abstract String getName()

Gets the name of this ephemeris format.

getTimes

@Nonnull
public abstract List<JulianDate> getTimes()

Gets the times of the data points.

getDistanceUnit

@Nonnull
public abstract StkEphemerisFile.DistanceUnit getDistanceUnit()

Gets the distance unit of the ephemeris and covariance information.

getTimeFormat

@Nonnull
public final StkEphemerisFile.StkTimeFormat getTimeFormat()

Gets the time format of the ephemeris and covariance information.

setTimeFormat

public final void setTimeFormat(@Nonnull
                                StkEphemerisFile.StkTimeFormat value)

Sets the time format of the ephemeris and covariance information.

getOrder

public abstract int getOrder()

Gets the number of derivatives in this data.

getInterpolator

public abstract TranslationalMotionInterpolator getInterpolator()

Gets the interpolator to use to interpolate this ephemeris data. This property may be null if no interpolator was specified or if the "InterpolationMethod" in the file was not available.

When reading an ephemeris file, this property may be null if the "InterpolationMethod" property did not exist in the file or if it could not be automatically mapped to a TranslationalMotionInterpolator instance. In the latter case, the original string representation of the name of the interpolation method can be found in the Properties (get) collection.

When writing an ephemeris file, and this property is non-null, it overrides "InterpolationMethod" in Properties (get). However, if this property is null, the value in Properties (get) is used.

setInterpolator

public abstract void setInterpolator(TranslationalMotionInterpolator value)

Sets the interpolator to use to interpolate this ephemeris data. This property may be null if no interpolator was specified or if the "InterpolationMethod" in the file was not available.

When reading an ephemeris file, this property may be null if the "InterpolationMethod" property did not exist in the file or if it could not be automatically mapped to a TranslationalMotionInterpolator instance. In the latter case, the original string representation of the name of the interpolation method can be found in the Properties (get) collection.

When writing an ephemeris file, and this property is non-null, it overrides "InterpolationMethod" in Properties (get). However, if this property is null, the value in Properties (get) is used.

createPoint

@Nonnull
public abstract Point createPoint()

Creates a Point whose time-varying position is computed by interpolating over the ephemeris data held by this instance.

Returns:

The point.