agi.foundation.ccsds

(agi.foundation.models-2025r1.jar)

Class CcsdsOrbitEphemerisMessageSegment

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.ccsds.CcsdsOrbitEphemerisMessageSegment

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class CcsdsOrbitEphemerisMessageSegment
extends DefinitionalObject

Ephemeris (and optionally covariance) data for an object that is valid for a given time period. CcsdsOrbitEphemerisMessageSegment.createPoint() can be used to make a PointInterpolator that can interpolate over the ephemeris data.

The CCSDS specifications can be found on the CCSDS website. The two supported formats for OEM files are Key-value notation (KVN) and extensible markup language (XML). The official recommended standards for KVN OEM files can be found in "Orbit Data Messages", Document CCSDS 502.0-B-2 on the above website. The official recommended standards for XML OEM files can be found in "XML Specifications for Navigation Data Messages", Document CCSDS 505.0-B-2 on the website. Both documents also contain a few useful examples of correctly formatted OEM files for their respective formats.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CcsdsOrbitEphemerisMessageSegment() Initializes a new instance.
protected	CcsdsOrbitEphemerisMessageSegment(CcsdsOrbitEphemerisMessageSegment existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

Modifier and Type	Method and Description
protected boolean	checkForSameDefinition(CcsdsOrbitEphemerisMessageSegment other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
Object	clone(CopyContext context) Clones this object using the specified context.
protected int	computeCurrentDefinitionHashCode() Computes a hash code based on the current properties of this object.
Point	createPoint() Creates a Point whose time-varying position is computed by interpolating over the ephemeris data held by this instance.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
String	getCenter() Gets the origin of the ReferenceFrameName (get / set), which may be a natural Solar System body, including any planet barycenter or the Solar System barycenter, or another spacecraft.
DateMotionCollection1<Axes>	getCovarianceAxes() Gets or sets a collection containing the axes of the covariance data.
DateMotionCollection1<String>	getCovarianceAxesNames() Gets a collection containing names for covariance axes that are different from those of the reference frame.
DateMotionCollection1<Matrix6By6Symmetric>	getCovarianceData() Gets the covariance data.
ArrayList<String>	getCovarianceDataComments() Gets a collection containing comments from the covariance data of a segment of a CCSDS OEM file.
DateMotionCollection1<Cartesian>	getEphemerisData() Gets the ephemeris data.
ArrayList<String>	getEphemerisDataComments() Gets a collection containing comments from the ephemeris data of a segment of a CCSDS OEM file.
CcsdsInterpolationMethod	getInterpolationMethod() Gets the optional interpolation method for the ephemeris data immediately following the metadata block.
int	getInterpolationOrder() Gets the interpolation order for the ephemeris data immediately following the metadata block.
TranslationalMotionInterpolator	getInterpolator() Gets or sets an interpolator for the ephemeris data.
ArrayList<String>	getMetaDataComments() Gets a collection containing comments from the metadata of a segment of a CCSDS OEM file.
String	getObjectId() Gets the object identifier for which the ephemeris is provided.
String	getObjectName() Gets the name of the object for which the ephemeris is provided.
ReferenceFrame	getReferenceFrame() Gets or sets the reference frame in which the ephemeris data is given.
JulianDate	getReferenceFrameEpoch() Gets the epoch of reference frame, if not intrinsic to the definition of the reference frame.
String	getReferenceFrameName() Gets or sets the name of the reference frame in which the ephemeris data are given.
CcsdsReferenceFrameType	getReferenceFrameType() Gets the type of the reference frame.
JulianDate	getStartTime() Gets the start of total time span covered by the ephemeris data and covariance data immediately following the metadata block.
JulianDate	getStopTime() Gets the end of total time span covered by ephemeris data and covariance data immediately following the metadata block.
TimeStandard	getTimeStandard() Gets or sets the time standard used for metadata, ephemeris data, and covariance data.
JulianDate	getUseableStartTime() Gets or sets the optional start of useable time span covered by ephemeris data immediately following the metadata block.
JulianDate	getUseableStopTime() Gets or sets the optional end of useable time span covered by ephemeris data immediately following the metadata block.
void	setCenter(String value) Sets the origin of the ReferenceFrameName (get / set), which may be a natural Solar System body, including any planet barycenter or the Solar System barycenter, or another spacecraft.
void	setCovarianceAxes(DateMotionCollection1<Axes> value) Gets or sets a collection containing the axes of the covariance data.
void	setCovarianceAxesNames(DateMotionCollection1<String> value) Sets a collection containing names for covariance axes that are different from those of the reference frame.
void	setCovarianceData(DateMotionCollection1<Matrix6By6Symmetric> value) Sets the covariance data.
void	setEphemerisData(DateMotionCollection1<Cartesian> value) Sets the ephemeris data.
void	setInterpolationMethod(CcsdsInterpolationMethod value) Sets the optional interpolation method for the ephemeris data immediately following the metadata block.
void	setInterpolationOrder(int value) Sets the interpolation order for the ephemeris data immediately following the metadata block.
void	setInterpolator(TranslationalMotionInterpolator value) Gets or sets an interpolator for the ephemeris data.
void	setObjectId(String value) Sets the object identifier for which the ephemeris is provided.
void	setObjectName(String value) Sets the name of the object for which the ephemeris is provided.
void	setReferenceFrame(ReferenceFrame value) Gets or sets the reference frame in which the ephemeris data is given.
void	setReferenceFrameEpoch(JulianDate value) Sets the epoch of reference frame, if not intrinsic to the definition of the reference frame.
void	setReferenceFrameName(String value) Gets or sets the name of the reference frame in which the ephemeris data are given.
void	setReferenceFrameType(CcsdsReferenceFrameType value) Sets the type of the reference frame.
void	setStartTime(JulianDate value) Sets the start of total time span covered by the ephemeris data and covariance data immediately following the metadata block.
void	setStopTime(JulianDate value) Sets the end of total time span covered by ephemeris data and covariance data immediately following the metadata block.
void	setTimeStandard(TimeStandard value) Gets or sets the time standard used for metadata, ephemeris data, and covariance data.
void	setUseableStartTime(JulianDate value) Gets or sets the optional start of useable time span covered by ephemeris data immediately following the metadata block.
void	setUseableStopTime(JulianDate value) Gets or sets the optional end of useable time span covered by ephemeris data immediately following the metadata block.

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

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

Constructor Detail

CcsdsOrbitEphemerisMessageSegment

public CcsdsOrbitEphemerisMessageSegment()

Initializes a new instance. EphemerisData (get / set), ReferenceFrame (get / set), and Interpolator (get / set) properties must be set before CcsdsOrbitEphemerisMessageSegment.createPoint() is called.

CcsdsOrbitEphemerisMessageSegment

protected CcsdsOrbitEphemerisMessageSegment(@Nonnull
                                            CcsdsOrbitEphemerisMessageSegment existingInstance,
                                            @Nonnull
                                            CopyContext context)

Initializes a new instance as a copy of an existing instance.

See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.

Parameters:

existingInstance - The existing instance to copy.

context - A CopyContext that controls the depth of the copy.

Throws:

ArgumentNullException - Thrown when existingInstance or context is null.

Method Detail

clone

public Object clone(CopyContext context)

Clones this object using the specified context.

This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.

A typical implementation of ICloneWithContext:

public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}

In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:

1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.

If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.

alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}

If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:

1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.

public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;

Specified by:

clone in interface ICloneWithContext

Specified by:

clone in class DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Specified by:

checkForSameDefinition in class DefinitionalObject

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(@Nullable
                                         CcsdsOrbitEphemerisMessageSegment other)

Checks to determine if another instance has the same definition as this instance and returns true if it does. Derived classes MUST override this method and check all new fields introduced by the derived class for definitional equivalence. It is NOT necessary to check base class fields because the base class will already have done that. When overriding this method, you should NOT call the base implementation because it will return false for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the CcsdsOrbitEphemerisMessageSegment.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. Derived classes which contain additional dependencies MUST override this method, call the base implementation, and enumerate dependencies introduced by the derived class.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getMetaDataComments

@Nonnull
public final ArrayList<String> getMetaDataComments()

Gets a collection containing comments from the metadata of a segment of a CCSDS OEM file.

getEphemerisDataComments

@Nonnull
public final ArrayList<String> getEphemerisDataComments()

Gets a collection containing comments from the ephemeris data of a segment of a CCSDS OEM file.

getCovarianceDataComments

@Nonnull
public final ArrayList<String> getCovarianceDataComments()

Gets a collection containing comments from the covariance data of a segment of a CCSDS OEM file.

getObjectName

public final String getObjectName()

Gets the name of the object for which the ephemeris is provided.

setObjectName

public final void setObjectName(String value)

Sets the name of the object for which the ephemeris is provided.

getObjectId

public final String getObjectId()

Gets the object identifier for which the ephemeris is provided.

setObjectId

public final void setObjectId(String value)

Sets the object identifier for which the ephemeris is provided.

getCenter

public final String getCenter()

Gets the origin of the ReferenceFrameName (get / set), which may be a natural Solar System body, including any planet barycenter or the Solar System barycenter, or another spacecraft.

setCenter

public final void setCenter(String value)

Sets the origin of the ReferenceFrameName (get / set), which may be a natural Solar System body, including any planet barycenter or the Solar System barycenter, or another spacecraft.

getReferenceFrameName

public final String getReferenceFrameName()

Gets or sets the name of the reference frame in which the ephemeris data are given.

The reference frame must be the same for all data elements, with the exception of the covariance matrix, for which an applicable different reference frame may be specified.

setReferenceFrameName

public final void setReferenceFrameName(String value)

Gets or sets the name of the reference frame in which the ephemeris data are given.

The reference frame must be the same for all data elements, with the exception of the covariance matrix, for which an applicable different reference frame may be specified.

getReferenceFrameEpoch

@Nullable
public final JulianDate getReferenceFrameEpoch()

Gets the epoch of reference frame, if not intrinsic to the definition of the reference frame.

setReferenceFrameEpoch

public final void setReferenceFrameEpoch(@Nullable
                                         JulianDate value)

Sets the epoch of reference frame, if not intrinsic to the definition of the reference frame.

getReferenceFrame

@Nullable
public final ReferenceFrame getReferenceFrame()

Gets or sets the reference frame in which the ephemeris data is given.

This value is not provided automatically by CcsdsOrbitEphemerisMessageFile.readFrom(String) because the reference frames given in OEM metadata are not necessarily supported as ReferenceFrame (get / set) objects.

If this is not provided by the user, an attempt will be made to infer the reference frame from the given center, reference frame, and reference frame epoch data. If this attempt fails, null will be returned.

The reference frame inference attempts to associate center names and reference frame names from the SANA website with ReferenceFrame (get / set) available from the CentralBody, SolarSystemBarycenter, and PlanetarySystemBarycenter types. Only a subset of the SANA reference frames are supported, so it may be necessary for the user to manually create their own reference frames.

The supported reference frames for Earth are listed below:

• ALIGN_EARTH is formed by creating a new AxesFixedAtJulianDate from the Axes (get / set) of the FixedFrame (get / set) at the ReferenceFrameEpoch (get / set) (which cannot be null). Those axes are then centered at the CenterOfMassPoint (get / set).
• GCRF, ICRF, and any other frame that starts with ICRF (e.g. ICRF1, ICRF2, etc.) is mapped to the InternationalCelestialReferenceFrame (get / set).
• EME2000 and J2000 are mapped to J2000Frame (get / set).
• J2000_ECLIPTIC is formed by rotating the Axes (get / set) of J2000Frame (get / set) by 84381.448 arc-seconds about its x-axis (Vernal equinox direction). Those axes are then centered at the CenterOfMassPoint (get / set).
• MOD and MOD_EARTH are mapped to the MeanEquatorMeanEquinoxFrame (get / set).
• TEME and TEMEOFDATE are mapped to TrueEquatorMeanEquinoxFrame (get / set).
• TEMEOFEPOCH is formed by creating a new AxesFixedAtJulianDate from the Axes (get / set) of the TrueEquatorMeanEquinoxFrame (get / set) at the ReferenceFrameEpoch (get / set) (which cannot be null). Those axes are then centered at the CenterOfMassPoint (get / set).
• TOD and TOD_EARTH are mapped to TrueEquatorTrueEquinoxFrame (get / set).
• ITRF, FIXED_EARTH, ECR, ECEF, and ECF are mapped to FixedFrame (get / set).
• TDR, GRC, GCR, GTOD, EFG are mapped to PseudoFixedFrame (get / set).

The supported reference frames for most CentralBody derived types are as follows:

• FIXED and FIXED_CB are mapped to the FixedFrame (get / set) of the body.
• INERTIAL and INERTIAL_CB are mapped to the InertialFrame (get / set) of the body.

The Sun also has a J2000 and J2000_ECLIPTIC frames whose axes are defined in the same manner as those of the Earth with the CenterOfMassPoint (get / set) as the center point.

The MCI frame is defined as the InertialFrame (get / set) of MarsCentralBody.

INERTIAL and INERTIAL_CB can also be mapped to the inertial frames of the SolarSystemBarycenter or one of the PlanetarySystemBarycenters if the Center (get / set) is one of the supported barycenters. Note that MERCURY BARYCENTER and VENUS BARYCENTER are not supported. It is suggested that Center (get / set) be manually changed to MERCURY or VENUS under those circumstances.

setReferenceFrame

public final void setReferenceFrame(@Nullable
                                    ReferenceFrame value)

Gets or sets the reference frame in which the ephemeris data is given.

This value is not provided automatically by CcsdsOrbitEphemerisMessageFile.readFrom(String) because the reference frames given in OEM metadata are not necessarily supported as ReferenceFrame (get / set) objects.

If this is not provided by the user, an attempt will be made to infer the reference frame from the given center, reference frame, and reference frame epoch data. If this attempt fails, null will be returned.

The reference frame inference attempts to associate center names and reference frame names from the SANA website with ReferenceFrame (get / set) available from the CentralBody, SolarSystemBarycenter, and PlanetarySystemBarycenter types. Only a subset of the SANA reference frames are supported, so it may be necessary for the user to manually create their own reference frames.

The supported reference frames for Earth are listed below:

• ALIGN_EARTH is formed by creating a new AxesFixedAtJulianDate from the Axes (get / set) of the FixedFrame (get / set) at the ReferenceFrameEpoch (get / set) (which cannot be null). Those axes are then centered at the CenterOfMassPoint (get / set).
• GCRF, ICRF, and any other frame that starts with ICRF (e.g. ICRF1, ICRF2, etc.) is mapped to the InternationalCelestialReferenceFrame (get / set).
• EME2000 and J2000 are mapped to J2000Frame (get / set).
• J2000_ECLIPTIC is formed by rotating the Axes (get / set) of J2000Frame (get / set) by 84381.448 arc-seconds about its x-axis (Vernal equinox direction). Those axes are then centered at the CenterOfMassPoint (get / set).
• MOD and MOD_EARTH are mapped to the MeanEquatorMeanEquinoxFrame (get / set).
• TEME and TEMEOFDATE are mapped to TrueEquatorMeanEquinoxFrame (get / set).
• TEMEOFEPOCH is formed by creating a new AxesFixedAtJulianDate from the Axes (get / set) of the TrueEquatorMeanEquinoxFrame (get / set) at the ReferenceFrameEpoch (get / set) (which cannot be null). Those axes are then centered at the CenterOfMassPoint (get / set).
• TOD and TOD_EARTH are mapped to TrueEquatorTrueEquinoxFrame (get / set).
• ITRF, FIXED_EARTH, ECR, ECEF, and ECF are mapped to FixedFrame (get / set).
• TDR, GRC, GCR, GTOD, EFG are mapped to PseudoFixedFrame (get / set).

The supported reference frames for most CentralBody derived types are as follows:

• FIXED and FIXED_CB are mapped to the FixedFrame (get / set) of the body.
• INERTIAL and INERTIAL_CB are mapped to the InertialFrame (get / set) of the body.

The Sun also has a J2000 and J2000_ECLIPTIC frames whose axes are defined in the same manner as those of the Earth with the CenterOfMassPoint (get / set) as the center point.

The MCI frame is defined as the InertialFrame (get / set) of MarsCentralBody.

INERTIAL and INERTIAL_CB can also be mapped to the inertial frames of the SolarSystemBarycenter or one of the PlanetarySystemBarycenters if the Center (get / set) is one of the supported barycenters. Note that MERCURY BARYCENTER and VENUS BARYCENTER are not supported. It is suggested that Center (get / set) be manually changed to MERCURY or VENUS under those circumstances.

getReferenceFrameType

@Nonnull
public final CcsdsReferenceFrameType getReferenceFrameType()

Gets the type of the reference frame.

setReferenceFrameType

public final void setReferenceFrameType(@Nonnull
                                        CcsdsReferenceFrameType value)

Sets the type of the reference frame.

getTimeStandard

public final TimeStandard getTimeStandard()

Gets or sets the time standard used for metadata, ephemeris data, and covariance data.

The valid values for CCSDS time systems are given by the SANA website. Only time systems that are compatible with the available TimeStandard (get / set) can be read by CcsdsOrbitEphemerisMessageFile.readFrom(String).

The mapping of CCSDS time systems from the Space Assigned Numbers Authority (SANA) to TimeStandard (get / set) is as follows:

• UT1 maps to UniversalTime1 (get).
• UTC maps to CoordinatedUniversalTime (get).
• GPS maps to GlobalPositioningSystemTime (get).
• TDB maps to BarycentricDynamicalTime (get).
• TAI maps to InternationalAtomicTime (get).
• TT maps to TerrestrialTime (get).

setTimeStandard

public final void setTimeStandard(TimeStandard value)

Gets or sets the time standard used for metadata, ephemeris data, and covariance data.

The valid values for CCSDS time systems are given by the SANA website. Only time systems that are compatible with the available TimeStandard (get / set) can be read by CcsdsOrbitEphemerisMessageFile.readFrom(String).

The mapping of CCSDS time systems from the Space Assigned Numbers Authority (SANA) to TimeStandard (get / set) is as follows:

• UT1 maps to UniversalTime1 (get).
• UTC maps to CoordinatedUniversalTime (get).
• GPS maps to GlobalPositioningSystemTime (get).
• TDB maps to BarycentricDynamicalTime (get).
• TAI maps to InternationalAtomicTime (get).
• TT maps to TerrestrialTime (get).

getStartTime

@Nonnull
public final JulianDate getStartTime()

Gets the start of total time span covered by the ephemeris data and covariance data immediately following the metadata block.

setStartTime

public final void setStartTime(@Nonnull
                               JulianDate value)

Sets the start of total time span covered by the ephemeris data and covariance data immediately following the metadata block.

getUseableStartTime

@Nullable
public final JulianDate getUseableStartTime()

Gets or sets the optional start of useable time span covered by ephemeris data immediately following the metadata block.

Note that this value is ignored by CcsdsOrbitEphemerisMessageSegment.createPoint().

setUseableStartTime

public final void setUseableStartTime(@Nullable
                                      JulianDate value)

Gets or sets the optional start of useable time span covered by ephemeris data immediately following the metadata block.

Note that this value is ignored by CcsdsOrbitEphemerisMessageSegment.createPoint().

getUseableStopTime

@Nullable
public final JulianDate getUseableStopTime()

Gets or sets the optional end of useable time span covered by ephemeris data immediately following the metadata block.

Note that this value is ignored by CcsdsOrbitEphemerisMessageSegment.createPoint().

setUseableStopTime

public final void setUseableStopTime(@Nullable
                                     JulianDate value)

Gets or sets the optional end of useable time span covered by ephemeris data immediately following the metadata block.

Note that this value is ignored by CcsdsOrbitEphemerisMessageSegment.createPoint().

getStopTime

@Nonnull
public final JulianDate getStopTime()

Gets the end of total time span covered by ephemeris data and covariance data immediately following the metadata block.

setStopTime

public final void setStopTime(@Nonnull
                              JulianDate value)

Sets the end of total time span covered by ephemeris data and covariance data immediately following the metadata block.

getInterpolationMethod

@Nonnull
public final CcsdsInterpolationMethod getInterpolationMethod()

Gets the optional interpolation method for the ephemeris data immediately following the metadata block.

setInterpolationMethod

public final void setInterpolationMethod(@Nonnull
                                         CcsdsInterpolationMethod value)

Sets the optional interpolation method for the ephemeris data immediately following the metadata block.

getInterpolationOrder

public final int getInterpolationOrder()

Gets the interpolation order for the ephemeris data immediately following the metadata block. By default, this is zero.

setInterpolationOrder

public final void setInterpolationOrder(int value)

Sets the interpolation order for the ephemeris data immediately following the metadata block. By default, this is zero.

getInterpolator

@Nullable
public final TranslationalMotionInterpolator getInterpolator()

Gets or sets an interpolator for the ephemeris data.

This value is not provided automatically by CcsdsOrbitEphemerisMessageFile.readFrom(String) because the interpolation information is optional.

If this is not provided by the user, an attempt will be made to build an interpolator from the given interpolation method, interpolation order, and ephemeris data. If this attempt fails, null will be returned. The user would then have to build an interpolator manually.

setInterpolator

public final void setInterpolator(@Nullable
                                  TranslationalMotionInterpolator value)

Gets or sets an interpolator for the ephemeris data.

This value is not provided automatically by CcsdsOrbitEphemerisMessageFile.readFrom(String) because the interpolation information is optional.

If this is not provided by the user, an attempt will be made to build an interpolator from the given interpolation method, interpolation order, and ephemeris data. If this attempt fails, null will be returned. The user would then have to build an interpolator manually.

getEphemerisData

public final DateMotionCollection1<Cartesian> getEphemerisData()

Gets the ephemeris data.

Note that these are converted from km in OEM files to meters for storage. Writing new OEM files converts them back to km.

setEphemerisData

public final void setEphemerisData(DateMotionCollection1<Cartesian> value)

Sets the ephemeris data.

Note that these are converted from km in OEM files to meters for storage. Writing new OEM files converts them back to km.

getCovarianceData

@Nonnull
public final DateMotionCollection1<Matrix6By6Symmetric> getCovarianceData()

Gets the covariance data.

Note that these are converted from km^2, km^2/s, and km^2/s^2 in OEM files to m^2, m^2/s, and m^2/s^2 for storage. Writing new OEM files converts them back to km^2, km^2/s, and km^2/s^2.

setCovarianceData

public final void setCovarianceData(@Nonnull
                                    DateMotionCollection1<Matrix6By6Symmetric> value)

Sets the covariance data.

Note that these are converted from km^2, km^2/s, and km^2/s^2 in OEM files to m^2, m^2/s, and m^2/s^2 for storage. Writing new OEM files converts them back to km^2, km^2/s, and km^2/s^2.

getCovarianceAxesNames

@Nonnull
public final DateMotionCollection1<String> getCovarianceAxesNames()

Gets a collection containing names for covariance axes that are different from those of the reference frame.

setCovarianceAxesNames

public final void setCovarianceAxesNames(@Nonnull
                                         DateMotionCollection1<String> value)

Sets a collection containing names for covariance axes that are different from those of the reference frame.

getCovarianceAxes

@Nullable
public final DateMotionCollection1<Axes> getCovarianceAxes()

Gets or sets a collection containing the axes of the covariance data.

This collection is not provided automatically by CcsdsOrbitEphemerisMessageFile.readFrom(String) because the axes provided with OEM covariance data are optional, and they are not necessarily supported as Axes objects.

If this is not provided by the user, an attempt will be made to build a collection of axes from the axes of given reference frame, the covariance axes names collection, and other data provided by the OEM file. If this attempt fails, null will be returned. The user would then have to build this collection manually.

Note that this data is not required by CcsdsOrbitEphemerisMessageSegment.createPoint().

All the reference frames supported in the remarks of ReferenceFrame (get / set) are also supported. Additionally, several of the Orbit-Relative Reference Frames available at the SANA website are supported. Because these frames are orbit relative, the inference algorithm attempts to use CcsdsOrbitEphemerisMessageSegment.createPoint() to generate the orbit that is used to define the coordinates. If CcsdsOrbitEphemerisMessageSegment.createPoint() fails by throwing an exception, then null will be returned. Additionally, a CentralBody must be able to be inferred from Center (get / set) in order for the inference to work.

All the orbit relative systems other than SEZ/SEZ_ROTATING use the non-null ReferenceFrame (get / set) if the ReferenceFrameType (get / set) is CcsdsReferenceFrameType.INERTIAL. Otherwise, they use the InertialFrame (get / set) of the CentralBody.

• SEZ and SEZ_ROTATING use the South/East/Zenith topocentric horizon system. This system is right-handed, Cartesian system rotating with the observing site. The local horizon forms the fundamental plane, with the S axis pointing due south from the site (even in the Southern Hemisphere). The E axis points east from the site. The Z axis (zenith) points radially outward from the site, along the site's geodetic local vertical. SEZ and SEZ_ROTATING use the non-null ReferenceFrame (get / set) if the ReferenceFrameType (get / set) is CcsdsReferenceFrameType.FIXED. Otherwise, they use the FixedFrame (get / set) of the CentralBody.
• LVLH and LVLH_ROTATING stand for "Local Vertical Local Horizontal". The Z-axis of the rotating LVLH frame is a unit vector collinear and opposite sign of the gravicentric satellite position (planet center, spacecraft gravity center), the Y-axis is a unit vector collinear but with the opposite sign of the orbital kinetic momentum (normal to orbit plane), and the X-axis completes the orthonormal triad.
• VNC, VNC_ROTATING, and VNB define a local orbital coordinate Velocity, Normal, Co-normal (Bi-normal for VNB) rotating frame that has the x-axis along the Velocity (or tangential) vector, y-axis Normal to the orbit along the orbital angular momentum vector, and z-axis is the "Co-normal" direction completing the right-handed system (i.e. for a circular orbit "C" points in the radius vector direction whereas for an eccentric orbit, "C" points as close to radial as possible while still being normal to the V-N plane).
• RSW, RSW_ROTATING, RTN, RIC, and QSW define a Radial, Along track, Cross track, local orbital coordinate rotating frame, where the R axis always points out from the satellite along the central body's radius vector to the satellite as it moves through the orbit. The S axis is in the direction of (but not necessarily parallel to) the velocity vector and is perpendicular to the radius vector. The W axis is aligned with the orbit angular momentum vector.
• NTW, NTW_ROTATING, and TVN define a local orbital coordinate rotating frame that has the y-axis along the Tangential (or inertial velocity) vector, z-axis ("W") along the orbital angular momentum vector, and N (the x-axis) completing the right-handed system (i.e., for a circular orbit "N" generally points in the radial direction and for an eccentric orbit, "N" points as close to radial as possible while still being normal to the T-W plane.
• TNW and TNW_ROTATING define a local orbital coordinate Tangential, Normal, Cross-track rotating frame that has the x-axis along the Tangential (or velocity) vector, z-axis ("W") along the orbital angular momentum vector, and N completing the right-handed system (i.e. for a circular orbit "N" generally points in the Nadir direction and for an eccentric orbit, "N" points as close to Nadir as possible while still being normal to the T-W plane).

setCovarianceAxes

public final void setCovarianceAxes(@Nullable
                                    DateMotionCollection1<Axes> value)

Gets or sets a collection containing the axes of the covariance data.

This collection is not provided automatically by CcsdsOrbitEphemerisMessageFile.readFrom(String) because the axes provided with OEM covariance data are optional, and they are not necessarily supported as Axes objects.

If this is not provided by the user, an attempt will be made to build a collection of axes from the axes of given reference frame, the covariance axes names collection, and other data provided by the OEM file. If this attempt fails, null will be returned. The user would then have to build this collection manually.

Note that this data is not required by CcsdsOrbitEphemerisMessageSegment.createPoint().

All the reference frames supported in the remarks of ReferenceFrame (get / set) are also supported. Additionally, several of the Orbit-Relative Reference Frames available at the SANA website are supported. Because these frames are orbit relative, the inference algorithm attempts to use CcsdsOrbitEphemerisMessageSegment.createPoint() to generate the orbit that is used to define the coordinates. If CcsdsOrbitEphemerisMessageSegment.createPoint() fails by throwing an exception, then null will be returned. Additionally, a CentralBody must be able to be inferred from Center (get / set) in order for the inference to work.

All the orbit relative systems other than SEZ/SEZ_ROTATING use the non-null ReferenceFrame (get / set) if the ReferenceFrameType (get / set) is CcsdsReferenceFrameType.INERTIAL. Otherwise, they use the InertialFrame (get / set) of the CentralBody.

• SEZ and SEZ_ROTATING use the South/East/Zenith topocentric horizon system. This system is right-handed, Cartesian system rotating with the observing site. The local horizon forms the fundamental plane, with the S axis pointing due south from the site (even in the Southern Hemisphere). The E axis points east from the site. The Z axis (zenith) points radially outward from the site, along the site's geodetic local vertical. SEZ and SEZ_ROTATING use the non-null ReferenceFrame (get / set) if the ReferenceFrameType (get / set) is CcsdsReferenceFrameType.FIXED. Otherwise, they use the FixedFrame (get / set) of the CentralBody.
• LVLH and LVLH_ROTATING stand for "Local Vertical Local Horizontal". The Z-axis of the rotating LVLH frame is a unit vector collinear and opposite sign of the gravicentric satellite position (planet center, spacecraft gravity center), the Y-axis is a unit vector collinear but with the opposite sign of the orbital kinetic momentum (normal to orbit plane), and the X-axis completes the orthonormal triad.
• VNC, VNC_ROTATING, and VNB define a local orbital coordinate Velocity, Normal, Co-normal (Bi-normal for VNB) rotating frame that has the x-axis along the Velocity (or tangential) vector, y-axis Normal to the orbit along the orbital angular momentum vector, and z-axis is the "Co-normal" direction completing the right-handed system (i.e. for a circular orbit "C" points in the radius vector direction whereas for an eccentric orbit, "C" points as close to radial as possible while still being normal to the V-N plane).
• RSW, RSW_ROTATING, RTN, RIC, and QSW define a Radial, Along track, Cross track, local orbital coordinate rotating frame, where the R axis always points out from the satellite along the central body's radius vector to the satellite as it moves through the orbit. The S axis is in the direction of (but not necessarily parallel to) the velocity vector and is perpendicular to the radius vector. The W axis is aligned with the orbit angular momentum vector.
• NTW, NTW_ROTATING, and TVN define a local orbital coordinate rotating frame that has the y-axis along the Tangential (or inertial velocity) vector, z-axis ("W") along the orbital angular momentum vector, and N (the x-axis) completing the right-handed system (i.e., for a circular orbit "N" generally points in the radial direction and for an eccentric orbit, "N" points as close to radial as possible while still being normal to the T-W plane.
• TNW and TNW_ROTATING define a local orbital coordinate Tangential, Normal, Cross-track rotating frame that has the x-axis along the Tangential (or velocity) vector, z-axis ("W") along the orbital angular momentum vector, and N completing the right-handed system (i.e. for a circular orbit "N" generally points in the Nadir direction and for an eccentric orbit, "N" points as close to Nadir as possible while still being normal to the T-W plane).

createPoint

@Nonnull
public final Point createPoint()

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

If the ReferenceFrame (get / set) or Interpolator (get / set) is not provided by the user, an attempt will be made to infer those values from the available information in other properties. If that attempt fails, a PropertyInvalidException will be thrown.

Returns:

The point.

Throws:

PropertyInvalidException - Thrown when EphemerisData (get / set), ReferenceFrame (get / set), or Interpolator (get / set) is null.