agi.foundation.celestial

(agi.foundation.models-2024r3.jar)

Class EarthCentralBody

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.CentralBody

agi.foundation.celestial.EarthCentralBody

All Implemented Interfaces:

IKinematicStateService, ILocationPointService, IOrientationAxesService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IThreadAware, IServiceProvider, IProvideNaifIdCode

public class EarthCentralBody
extends CentralBody
implements IProvideNaifIdCode

The planet Earth. You should generally obtain an instance of this class from the CentralBodiesFacet instance in the calculation context instead of creating one directly.

This example shows how to obtain the Earth from the calculation context:

EarthCentralBody earth = CentralBodiesFacet.getFromContext().getEarth();

See EarthCentralBody.EarthCentralBody() for a description of the default instance of this class that is found in the CalculationContext.

Constructor Summary

Constructors

Modifier	Constructor and Description
	EarthCentralBody() Initializes a new instance.
protected	EarthCentralBody(EarthCentralBody 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(CentralBody other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(EarthCentralBody 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.
void	enumerateDependencies(DependencyEnumerator enumerator) Enumerates the dependencies of this object by calling DependencyEnumerator#enumerate(T) for each object that this object directly depends upon.
Point	getCenterOfMassPoint() Gets a point describing the center of mass of this central body.
EquationOfEquinoxes	getEquationOfEquinoxes() Gets the default model for the equation of the equinoxes which defines the right ascension of the mean equinox with respect to the true equator and equinox.
ReferenceFrame	getFixedFrame() Gets the default Fixed frame that corresponds to the surface features of this central body.
ReferenceFrame	getInertialFrame() Gets the default Inertial frame for this central body.
ReferenceFrame	getInternationalCelestialReferenceFrame() Gets the International Celestial Reference Frame.
ReferenceFrame	getJ2000Frame() Gets the J2000 Reference Frame.
ReferenceFrame	getMeanEclipticMeanEquinoxFrame() Gets the Mean Ecliptic Mean Equinox Reference Frame.
ReferenceFrame	getMeanEclipticTrueEquinoxFrame() Gets the Mean Ecliptic True Equinox Reference Frame.
ReferenceFrame	getMeanEquatorMeanEquinoxFrame() Gets the Mean Equator Mean Equinox Reference Frame, also known as the "Mean of Date" reference frame.
TerrainProvider	getMeanSeaLevel() Gets the default mean sea level surface.
int	getNaifIdCode() Gets the NAIF identification code of this central body, barycenter, spacecraft, ground station, or other physical object or location.
String	getName() Gets the name of the central body.
NutationModel	getNutationModel() Gets the default nutation model used in the FK5 transformation from J2000 to the Fixed frame.
EarthOrientationParameters	getOrientationParameters() Gets the default EarthOrientationParameters.
PrecessionModel	getPrecessionModel() Gets the default precession model used in the FK5 transformation from J2000 to the Fixed frame.
ReferenceFrame	getPrincipalFrame() Gets the default Fixed frame that corresponds to the gravity frame of this central body.
ReferenceFrame	getPseudoFixedFrame() Gets the pseudo-fixed reference frame.
Ellipsoid	getShape() Gets the shape of this central body.
double	getSlowChangingAxesUpdateInterval() Gets the interval, in seconds, on which to recalculate slow-changing relationships between axes.
ReferenceFrame	getTrueEquatorMeanEquinoxFrame() Gets the True Equator, Mean Equinox (TEME) Reference Frame.
ReferenceFrame	getTrueEquatorTrueEquinoxFrame() Gets the True Equator True Equinox Reference Frame, also known as the "True of Date" reference frame.
void	setCenterOfMassPoint(Point value) Sets a point describing the center of mass of this central body.
void	setEquationOfEquinoxes(EquationOfEquinoxes value) Sets the default model for the equation of the equinoxes which defines the right ascension of the mean equinox with respect to the true equator and equinox.
void	setFixedFrame(ReferenceFrame value) Sets the default Fixed frame that corresponds to the surface features of this central body.
void	setInertialFrame(ReferenceFrame value) Sets the default Inertial frame for this central body.
void	setInternationalCelestialReferenceFrame(ReferenceFrame value) Sets the International Celestial Reference Frame.
void	setJ2000Frame(ReferenceFrame value) Sets the J2000 Reference Frame.
void	setMeanEclipticMeanEquinoxFrame(ReferenceFrame value) Sets the Mean Ecliptic Mean Equinox Reference Frame.
void	setMeanEclipticTrueEquinoxFrame(ReferenceFrame value) Sets the Mean Ecliptic True Equinox Reference Frame.
void	setMeanEquatorMeanEquinoxFrame(ReferenceFrame value) Sets the Mean Equator Mean Equinox Reference Frame, also known as the "Mean of Date" reference frame.
void	setMeanSeaLevel(TerrainProvider value) Sets the default mean sea level surface.
void	setName(String value) Sets the name of the central body.
void	setNutationModel(NutationModel value) Sets the default nutation model used in the FK5 transformation from J2000 to the Fixed frame.
void	setOrientationParameters(EarthOrientationParameters value) Sets the default EarthOrientationParameters.
void	setPrecessionModel(PrecessionModel value) Sets the default precession model used in the FK5 transformation from J2000 to the Fixed frame.
void	setPrincipalFrame(ReferenceFrame value) Sets the default Fixed frame that corresponds to the gravity frame of this central body.
void	setPseudoFixedFrame(ReferenceFrame value) Sets the pseudo-fixed reference frame.
void	setShape(Ellipsoid value) Sets the shape of this central body.
void	setSlowChangingAxesUpdateInterval(double value) Sets the interval, in seconds, on which to recalculate slow-changing relationships between axes.
void	setTrueEquatorMeanEquinoxFrame(ReferenceFrame value) Sets the True Equator, Mean Equinox (TEME) Reference Frame.
void	setTrueEquatorTrueEquinoxFrame(ReferenceFrame value) Sets the True Equator True Equinox Reference Frame, also known as the "True of Date" reference frame.
void	synchronizeOrigins() Sets the Origin (get / set) of the InertialFrame (get / set), J2000Frame (get / set), InternationalCelestialReferenceFrame (get / set), FixedFrame (get / set), PrincipalFrame (get / set), PseudoFixedFrame (get / set), MeanEquatorMeanEquinoxFrame (get / set), MeanEclipticMeanEquinoxFrame (get / set), MeanEclipticTrueEquinoxFrame (get / set), TrueEquatorTrueEquinoxFrame (get / set), and TrueEquatorMeanEquinoxFrame (get / set) to the current CenterOfMassPoint (get / set).

Methods inherited from class agi.foundation.celestial.CentralBody

checkForSameDefinition, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getIsThreadSafe, getLocationPoint, getOrientationAxes, getReferenceFrame, getService, observeCartographicPoint, observeCartographicPoint

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

EarthCentralBody

public EarthCentralBody()

Initializes a new instance.

This example shows how to obtain the Earth from the calculation context:

EarthCentralBody earth = CentralBodiesFacet.getFromContext().getEarth();

You should generally obtain an instance of this class from the CentralBodiesFacet instance in the calculation context instead of creating one directly.

A default-constructed instance of EarthCentralBody has the following characteristics:

• The CenterOfMassPoint (get / set) is defined by Earth (get). Consider using JplDE.useForCentralBodyPositions(agi.foundation.celestial.CentralBodiesFacet) to configure this and other central bodies with a much more accurate model of their positions using JPL DE data.
• The Shape (get / set) is the WGS84 ellipsoid returned by Shape (get).
• The PrecessionModel (get / set) is Iau1976Precession configured without any caching.
• The NutationModel (get / set) is Updated1980NutationModel (get) configured without any caching.
• The OrientationParameters (get / set) property is initialized to a default-constructed instance of EarthOrientationParameters. This means that, by default, the pole is assumed not to wander and the difference between UT1 and UTC is 0.0 seconds. For more accurate modeling of the relationship between the Fixed and Inertial reference frames, use EarthOrientationParametersFile to load an up-to-date EOP file.
• The MeanSeaLevel (get / set) surface is not defined. Consider configuring it with an instance of EarthGravityModel96MeanSeaLevel.
• The reference frames are defined using the configured PrecessionModel (get / set), NutationModel (get / set), and OrientationParameters (get / set). If you change any of these properties, the reference frames will use the new values.

EarthCentralBody

protected EarthCentralBody(@Nonnull
                           EarthCentralBody 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(CentralBody 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 CentralBody

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(EarthCentralBody 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 EarthCentralBody.checkForSameDefinition(agi.foundation.celestial.CentralBody) method.

Overrides:

computeCurrentDefinitionHashCode in class CentralBody

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.

getName

public String getName()

Gets the name of the central body.

Specified by:

getName in class CentralBody

setName

public void setName(String value)

Sets the name of the central body.

Specified by:

setName in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getShape

public Ellipsoid getShape()

Gets the shape of this central body.

By default this is the WGS84 oblate ellipsoid model of the Earth.

Specified by:

getShape in class CentralBody

setShape

public void setShape(Ellipsoid value)

Sets the shape of this central body.

By default this is the WGS84 oblate ellipsoid model of the Earth.

Specified by:

setShape in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getCenterOfMassPoint

public Point getCenterOfMassPoint()

Gets a point describing the center of mass of this central body.

Setting this property will also set the origin of all of the reference frames.

Specified by:

getCenterOfMassPoint in class CentralBody

setCenterOfMassPoint

public void setCenterOfMassPoint(Point value)

Sets a point describing the center of mass of this central body.

Setting this property will also set the origin of all of the reference frames.

Specified by:

setCenterOfMassPoint in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getInertialFrame

public ReferenceFrame getInertialFrame()

Gets the default Inertial frame for this central body.

By default this is the same as the reference frame returned by InternationalCelestialReferenceFrame (get / set).

Specified by:

getInertialFrame in class CentralBody

setInertialFrame

public void setInertialFrame(ReferenceFrame value)

Sets the default Inertial frame for this central body.

By default this is the same as the reference frame returned by InternationalCelestialReferenceFrame (get / set).

Specified by:

setInertialFrame in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getPrincipalFrame

public ReferenceFrame getPrincipalFrame()

Gets the default Fixed frame that corresponds to the gravity frame of this central body.

Specified by:

getPrincipalFrame in class CentralBody

setPrincipalFrame

public void setPrincipalFrame(ReferenceFrame value)

Sets the default Fixed frame that corresponds to the gravity frame of this central body.

Specified by:

setPrincipalFrame in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

synchronizeOrigins

public void synchronizeOrigins()

Sets the Origin (get / set) of the InertialFrame (get / set), J2000Frame (get / set), InternationalCelestialReferenceFrame (get / set), FixedFrame (get / set), PrincipalFrame (get / set), PseudoFixedFrame (get / set), MeanEquatorMeanEquinoxFrame (get / set), MeanEclipticMeanEquinoxFrame (get / set), MeanEclipticTrueEquinoxFrame (get / set), TrueEquatorTrueEquinoxFrame (get / set), and TrueEquatorMeanEquinoxFrame (get / set) to the current CenterOfMassPoint (get / set).

Specified by:

synchronizeOrigins in class CentralBody

getJ2000Frame

@Nonnull
public final ReferenceFrame getJ2000Frame()

Gets the J2000 Reference Frame.

setJ2000Frame

public final void setJ2000Frame(@Nonnull
                                ReferenceFrame value)

Sets the J2000 Reference Frame.

Throws:

ArgumentNullException - Thrown when value is null.

getInternationalCelestialReferenceFrame

@Nonnull
public final ReferenceFrame getInternationalCelestialReferenceFrame()

Gets the International Celestial Reference Frame.

setInternationalCelestialReferenceFrame

public final void setInternationalCelestialReferenceFrame(@Nonnull
                                                          ReferenceFrame value)

Sets the International Celestial Reference Frame.

Throws:

ArgumentNullException - Thrown when value is null.

getMeanEquatorMeanEquinoxFrame

@Nonnull
public final ReferenceFrame getMeanEquatorMeanEquinoxFrame()

Gets the Mean Equator Mean Equinox Reference Frame, also known as the "Mean of Date" reference frame.

setMeanEquatorMeanEquinoxFrame

public final void setMeanEquatorMeanEquinoxFrame(@Nonnull
                                                 ReferenceFrame value)

Sets the Mean Equator Mean Equinox Reference Frame, also known as the "Mean of Date" reference frame.

Throws:

ArgumentNullException - Thrown when value is null.

getMeanEclipticMeanEquinoxFrame

@Nonnull
public final ReferenceFrame getMeanEclipticMeanEquinoxFrame()

Gets the Mean Ecliptic Mean Equinox Reference Frame.

setMeanEclipticMeanEquinoxFrame

public final void setMeanEclipticMeanEquinoxFrame(@Nonnull
                                                  ReferenceFrame value)

Sets the Mean Ecliptic Mean Equinox Reference Frame.

Throws:

ArgumentNullException - Thrown when value is null.

getMeanEclipticTrueEquinoxFrame

@Nonnull
public final ReferenceFrame getMeanEclipticTrueEquinoxFrame()

Gets the Mean Ecliptic True Equinox Reference Frame.

setMeanEclipticTrueEquinoxFrame

public final void setMeanEclipticTrueEquinoxFrame(@Nonnull
                                                  ReferenceFrame value)

Sets the Mean Ecliptic True Equinox Reference Frame.

Throws:

ArgumentNullException - Thrown when value is null.

getTrueEquatorTrueEquinoxFrame

@Nonnull
public final ReferenceFrame getTrueEquatorTrueEquinoxFrame()

Gets the True Equator True Equinox Reference Frame, also known as the "True of Date" reference frame.

setTrueEquatorTrueEquinoxFrame

public final void setTrueEquatorTrueEquinoxFrame(@Nonnull
                                                 ReferenceFrame value)

Sets the True Equator True Equinox Reference Frame, also known as the "True of Date" reference frame.

getTrueEquatorMeanEquinoxFrame

@Nonnull
public final ReferenceFrame getTrueEquatorMeanEquinoxFrame()

Gets the True Equator, Mean Equinox (TEME) Reference Frame.

setTrueEquatorMeanEquinoxFrame

public final void setTrueEquatorMeanEquinoxFrame(@Nonnull
                                                 ReferenceFrame value)

Sets the True Equator, Mean Equinox (TEME) Reference Frame.

getPseudoFixedFrame

@Nonnull
public final ReferenceFrame getPseudoFixedFrame()

Gets the pseudo-fixed reference frame. The pseudo-fixed frame does not include the effect of pole wander. Note that this does include the s-prime correction from the International Celestial Reference System. So the only difference between the pseudo-fixed frame and the fixed frame is the 'x' and 'y' offset terms from pole wander computed by the EarthOrientationParameters (EOP). If the EOP data is default (zeros), the pseudo-fixed frame will be the same as the FixedFrame (get / set).

setPseudoFixedFrame

public final void setPseudoFixedFrame(@Nonnull
                                      ReferenceFrame value)

Sets the pseudo-fixed reference frame. The pseudo-fixed frame does not include the effect of pole wander. Note that this does include the s-prime correction from the International Celestial Reference System. So the only difference between the pseudo-fixed frame and the fixed frame is the 'x' and 'y' offset terms from pole wander computed by the EarthOrientationParameters (EOP). If the EOP data is default (zeros), the pseudo-fixed frame will be the same as the FixedFrame (get / set).

Throws:

ArgumentNullException - Thrown when value is null.

getFixedFrame

public ReferenceFrame getFixedFrame()

Gets the default Fixed frame that corresponds to the surface features of this central body.

The transformation between the default value of this frame and the International Celestial Reference Frame (ICRF) matches the Standards of Fundamental Astronomy (SOFA) IAU 2006/2000A model to the microarcsecond level.

Specified by:

getFixedFrame in class CentralBody

setFixedFrame

public void setFixedFrame(ReferenceFrame value)

Sets the default Fixed frame that corresponds to the surface features of this central body.

The transformation between the default value of this frame and the International Celestial Reference Frame (ICRF) matches the Standards of Fundamental Astronomy (SOFA) IAU 2006/2000A model to the microarcsecond level.

Specified by:

setFixedFrame in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getPrecessionModel

@Nonnull
public final PrecessionModel getPrecessionModel()

Gets the default precession model used in the FK5 transformation from J2000 to the Fixed frame.

setPrecessionModel

public final void setPrecessionModel(@Nonnull
                                     PrecessionModel value)

Sets the default precession model used in the FK5 transformation from J2000 to the Fixed frame.

getNutationModel

@Nonnull
public final NutationModel getNutationModel()

Gets the default nutation model used in the FK5 transformation from J2000 to the Fixed frame. By default, this is Updated1980NutationModel (get).

setNutationModel

public final void setNutationModel(@Nonnull
                                   NutationModel value)

Sets the default nutation model used in the FK5 transformation from J2000 to the Fixed frame. By default, this is Updated1980NutationModel (get).

Throws:

ArgumentNullException - Thrown when value is null.

getEquationOfEquinoxes

@Nonnull
public final EquationOfEquinoxes getEquationOfEquinoxes()

Gets the default model for the equation of the equinoxes which defines the right ascension of the mean equinox with respect to the true equator and equinox. By default, this uses the UpdatedEquationOfEquinoxes (get).

setEquationOfEquinoxes

public final void setEquationOfEquinoxes(@Nonnull
                                         EquationOfEquinoxes value)

Sets the default model for the equation of the equinoxes which defines the right ascension of the mean equinox with respect to the true equator and equinox. By default, this uses the UpdatedEquationOfEquinoxes (get).

Throws:

ArgumentNullException - Thrown when value is null.

getOrientationParameters

@Nullable
public final EarthOrientationParameters getOrientationParameters()

Gets the default EarthOrientationParameters.

Normally, this is initialized by default to an empty instance of EarthOrientationParameters. However, if the environment variable DME_COMPONENT_LIBRARIES_NO_DEFAULT_EARTH_ORIENTATION_PARAMETERS is set, then this will be left null which will cause exceptions when EOP data is required.

setOrientationParameters

public final void setOrientationParameters(@Nullable
                                           EarthOrientationParameters value)

Sets the default EarthOrientationParameters.

Normally, this is initialized by default to an empty instance of EarthOrientationParameters. However, if the environment variable DME_COMPONENT_LIBRARIES_NO_DEFAULT_EARTH_ORIENTATION_PARAMETERS is set, then this will be left null which will cause exceptions when EOP data is required.

getSlowChangingAxesUpdateInterval

public final double getSlowChangingAxesUpdateInterval()

Gets the interval, in seconds, on which to recalculate slow-changing relationships between axes.

A number of factors, including nutation, precession, and pole wander, affect the relationship between the FixedFrame (get / set) and InertialFrame (get / set). However, because the impact of these factors is small, and because they change relatively slowly, it is usually unnecessary to recalculate these parameters for each new input JulianDate. Instead, these values can be calculated once for a "window" of times and reused for all times within that window. This property allows the user to set the size of the window.

By default, a window size of 0 is used, so these parameters are recomputed for every JulianDate. Setting it to 1800 seconds (30 minutes) results in sufficient accuracy for most applications while also yielding much better performance when transforming between reference frames.

setSlowChangingAxesUpdateInterval

public final void setSlowChangingAxesUpdateInterval(double value)

Sets the interval, in seconds, on which to recalculate slow-changing relationships between axes.

A number of factors, including nutation, precession, and pole wander, affect the relationship between the FixedFrame (get / set) and InertialFrame (get / set). However, because the impact of these factors is small, and because they change relatively slowly, it is usually unnecessary to recalculate these parameters for each new input JulianDate. Instead, these values can be calculated once for a "window" of times and reused for all times within that window. This property allows the user to set the size of the window.

By default, a window size of 0 is used, so these parameters are recomputed for every JulianDate. Setting it to 1800 seconds (30 minutes) results in sufficient accuracy for most applications while also yielding much better performance when transforming between reference frames.

getMeanSeaLevel

@Nullable
public final TerrainProvider getMeanSeaLevel()

Gets the default mean sea level surface.

This example shows how to create an EGM96 mean sea level surface and configure it for use by all other calculations which need MSL.

EarthCentralBody earth = CentralBodiesFacet.getFromContext().getEarth();
EarthGravityModel96MeanSeaLevel msl = new EarthGravityModel96MeanSeaLevel();
earth.setMeanSeaLevel(msl);

By default, this is null.

setMeanSeaLevel

public final void setMeanSeaLevel(@Nullable
                                  TerrainProvider value)

Sets the default mean sea level surface.

This example shows how to create an EGM96 mean sea level surface and configure it for use by all other calculations which need MSL.

EarthCentralBody earth = CentralBodiesFacet.getFromContext().getEarth();
EarthGravityModel96MeanSeaLevel msl = new EarthGravityModel96MeanSeaLevel();
earth.setMeanSeaLevel(msl);

By default, this is null.

getNaifIdCode

public final int getNaifIdCode()

Gets the NAIF identification code of this central body, barycenter, spacecraft, ground station, or other physical object or location.

A directory of NAIF IDs associated with commonly used Solar System bodies is available at the NAIF website.

Specified by:

getNaifIdCode in interface IProvideNaifIdCode