public class PlanetsBspEphemerisProvider extends JplSpkEphemerisProvider
If STK is installed with the Planetary Data Supplement, the file planets.bsp is available in the STKData/Spice folder of the STK installation. This should be used input for the constructors of this class.
If STK or the Planetary Data Supplement are unavailable, the next best option is use
JplDE.useForCentralBodyPositions(agi.foundation.celestial.CentralBodiesFacet) to define the planetary barycenter positions
and then use Jup365BspEphemerisProvider, Sat441BspEphemerisProvider,
Ura111BspEphemerisProvider, Nep097BspEphemerisProvider,
and Plu058BspEphemerisProvider to define the positions of the planets with
respect to their planetary system barycenters. MarsBspEphemerisProvider
with mar097.bsp can optionally be used to define Mars with respect to its barycenter
if the miniscule distance (about 10-20 cm) between Mars and its barycenter is
important in an application.
| Modifier | Constructor and Description |
|---|---|
|
PlanetsBspEphemerisProvider(JplSpkFile file)
Initializes an instance using the specified
JplSpkFile instance. |
protected |
PlanetsBspEphemerisProvider(PlanetsBspEphemerisProvider existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
|
PlanetsBspEphemerisProvider(StreamFactory streamFactory)
Initializes a new instance with the specified stream factory.
|
|
PlanetsBspEphemerisProvider(String filename)
Initializes an instance using the specified planets.bsp filename.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(JplSpkEphemerisProvider other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(PlanetsBspEphemerisProvider 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. |
protected void |
freezeAggregatedObjects()
Called by
DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. |
Point |
getEarthMoonBarycenter()
Gets a point representing the location of the barycenter
of the Earth-Moon system.
|
Point |
getEarthPoint()
Gets a point representing the location of Earth.
|
Point |
getJupiterPoint()
Gets a point representing the location of Jupiter.
|
Point |
getJupiterSystemBarycenter()
Gets a point representing the location of the barycenter
of the Jupiter system.
|
Point |
getMarsPoint()
Gets a point representing the location of Mars (which
is identical to the position of the Mars system
barycenter in this model).
|
Point |
getMarsSystemBarycenter()
Gets a point representing the location of the barycenter
of the Mars system.
|
Point |
getMercuryPoint()
Gets a point representing the location of Mercury.
|
Point |
getMoonPoint()
Gets a point representing the location of the Moon.
|
Point |
getNeptunePoint()
Gets a point representing the location of Neptune.
|
Point |
getNeptuneSystemBarycenter()
Gets a point representing the location of the barycenter
of the Neptune system.
|
Point |
getPlutoPoint()
Gets a point representing the location of Pluto.
|
Point |
getPlutoSystemBarycenter()
Gets a point representing the location of the barycenter
of the Pluto system.
|
Point |
getSaturnPoint()
Gets a point representing the location of Saturn.
|
Point |
getSaturnSystemBarycenter()
Gets a point representing the location of the barycenter
of the Saturn system.
|
Point |
getSolarSystemBarycenter()
Gets a point representing the location of the barycenter
of the Solar System.
|
Point |
getSunPoint()
Gets a point representing the location of the Sun.
|
Point |
getUranusPoint()
Gets a point representing the location of Uranus.
|
Point |
getUranusSystemBarycenter()
Gets a point representing the location of the barycenter
of the Uranus system.
|
Point |
getVenusPoint()
Gets a point representing the location of Venus.
|
void |
useForCentralBodyPositions(CentralBodiesFacet centralBodiesFacet)
Uses this ephemeris provider for the positions of the Sun, planetary barycenters, planets,
Pluto, and the Moon.
|
checkForSameDefinition, getFile, modelSolarSystemUsingPlanetaryDataSupplement, modelSolarSystemUsingPublicJplDataareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic PlanetsBspEphemerisProvider(@Nonnull String filename)
filename - The full path and filename of the planets.bsp file.ArgumentNullException - Thrown when filename is null.public PlanetsBspEphemerisProvider(@Nonnull StreamFactory streamFactory)
The streams created by streamFactory must support seeking.
This means that the streams must implement
ISeekableStream or
FileInputStream.
streamFactory - The factory to use to create streams to read the JPL SPK data.ArgumentNullException - Thrown when streamFactory is null.public PlanetsBspEphemerisProvider(@Nonnull JplSpkFile file)
JplSpkFile instance.file - The JplSpkFile instance to use.ArgumentNullException - Thrown when file is null.protected PlanetsBspEphemerisProvider(@Nonnull PlanetsBspEphemerisProvider existingInstance, CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
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;clone in interface ICloneWithContextclone in class DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(JplSpkEphemerisProvider other)
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).checkForSameDefinition in class JplSpkEphemerisProviderother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(PlanetsBspEphemerisProvider other)
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).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
PlanetsBspEphemerisProvider.checkForSameDefinition(agi.foundation.spice.JplSpkEphemerisProvider) method.computeCurrentDefinitionHashCode in class JplSpkEphemerisProviderpublic void enumerateDependencies(DependencyEnumerator enumerator)
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.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class JplSpkEphemerisProviderenumerator - The enumerator that is informed of the dependencies of this object.protected void freezeAggregatedObjects()
DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
Derived classes which contain additional aggregated objects MUST override this method, call the base
implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be
frozen in this method are frequently created in this object's constructor and are not settable via
properties.freezeAggregatedObjects in class JplSpkEphemerisProviderpublic void useForCentralBodyPositions(CentralBodiesFacet centralBodiesFacet)
CentralBodiesFacet instance.
To use this ephemeris provider for only one of these barycenters or central bodies, use
one of the available points. This method also calls CentralBody.synchronizeOrigins()
on the barycenters and central bodies.
useForCentralBodyPositions in class JplSpkEphemerisProvidercentralBodiesFacet - The central bodies to update to use this data.ArgumentNullException - Thrown when centralBodiesFacet is null.@Nonnull public final Point getSolarSystemBarycenter()
@Nonnull public final Point getSunPoint()
@Nonnull public final Point getMercuryPoint()
@Nonnull public final Point getVenusPoint()
@Nonnull public final Point getEarthMoonBarycenter()
@Nonnull public final Point getEarthPoint()
@Nonnull public final Point getMoonPoint()
@Nonnull public final Point getMarsSystemBarycenter()
@Nonnull public final Point getMarsPoint()
@Nonnull public final Point getJupiterSystemBarycenter()
@Nonnull public final Point getJupiterPoint()
@Nonnull public final Point getSaturnSystemBarycenter()
@Nonnull public final Point getSaturnPoint()
@Nonnull public final Point getUranusSystemBarycenter()
@Nonnull public final Point getUranusPoint()
@Nonnull public final Point getNeptuneSystemBarycenter()
@Nonnull public final Point getNeptunePoint()
@Nonnull public final Point getPlutoSystemBarycenter()