AsteroidsBspEphemerisProvider

java.lang.Object
- agi.foundation.infrastructure.DefinitionalObject
- - agi.foundation.spice.JplSpkEphemerisProvider
  - - agi.foundation.spice.AsteroidsBspEphemerisProvider

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable
```
public class AsteroidsBspEphemerisProvider
extends JplSpkEphemerisProvider
```
Provides access to the positions of asteroids with respect to the Solar System barycenter.

If STK is installed with the Planetary Data Supplement, the file asteroids.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 to go to the website of the Solar System Dynamics (SSD) group of JPL to build your own *.bsp files for desired asteroids. First, the target body needs to be set to the desired asteroid and the time specification needs to be set for the desired time period. If the ephemeris type is set to "Small-Body SPK File", clicking "Generate Ephemeris" will create and download a *.bsp ephemeris for that small body that is usually titled using the NAIF ID of the small body. Go to your local Downloads folder and rename the file to the name of the asteroid, if the asteroid has a name. These files can then be used with CeresBspEphemerisProvider, VestaBspEphemerisProvider, or custom JplSpkEphemerisProvider classes to provide ephemeris for asteroids.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AsteroidsBspEphemerisProvider(AsteroidsBspEphemerisProvider existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.
	`AsteroidsBspEphemerisProvider(JplSpkFile file)` Initializes an instance using the specified `JplSpkFile` instance.
	`AsteroidsBspEphemerisProvider(StreamFactory streamFactory)` Initializes a new instance with the specified stream factory.
	`AsteroidsBspEphemerisProvider(String filename)` Initializes an instance using the specified asteroids.bsp filename.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected boolean`	`checkForSameDefinition(AsteroidsBspEphemerisProvider other)` Checks to determine if another instance has the same definition as this instance and returns `true` if it does.
`protected boolean`	`checkForSameDefinition(JplSpkEphemerisProvider 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`	`getCeresPoint()` Gets a point representing the location of Ceres.
`Point`	`getDidymosPoint()` Gets a point representing the location of Didymos.
`Point`	`getDonaldJohansonPoint()` Gets a point representing the location of DonaldJohanson.
`Point`	`getErosPoint()` Gets a point representing the location of Eros.
`Point`	`getEurybatesPoint()` Gets a point representing the location of Eurybates.
`Point`	`getGasparaPoint()` Gets a point representing the location of Gaspara.
`Point`	`getIdaPoint()` Gets a point representing the location of Ida.
`Point`	`getItokawaPoint()` Gets a point representing the location of Itokawa.
`Point`	`getLeucusPoint()` Gets a point representing the location of Leucus.
`Point`	`getLutetiaPoint()` Gets a point representing the location of Lutetia.
`Point`	`getMathildePoint()` Gets a point representing the location of Mathilde.
`Point`	`getOrusPoint()` Gets a point representing the location of Orus.
`Point`	`getPatroclusPoint()` Gets a point representing the location of Patroclus.
`Point`	`getPolymelePoint()` Gets a point representing the location of Polymele.
`Point`	`getPsychePoint()` Gets a point representing the location of Psyche.
`Point`	`getRyuguPoint()` Gets a point representing the location of Ryugu.
`Point`	`getSolarSystemBarycenter()` Gets a point representing the location of the barycenter of the Solar System.
`Point`	`getSteinsPoint()` Gets a point representing the location of Steins.
`Point`	`getVestaPoint()` Gets a point representing the location of Vesta.
`Point`	`getVirginiaPoint()` Gets a point representing the location of the asteroid Virginia.
`void`	`useForCentralBodyPositions(CentralBodiesFacet centralBodiesFacet)` Uses this ephemeris provider for the positions of the centers of mass of Ceres and Vesta in the specified `CentralBodiesFacet` instance.

Methods inherited from class agi.foundation.spice.JplSpkEphemerisProvider
checkForSameDefinition, getFile, modelSolarSystemUsingPlanetaryDataSupplement, modelSolarSystemUsingPublicJplData

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AsteroidsBspEphemerisProvider
```
public AsteroidsBspEphemerisProvider(@Nonnull
                                     String filename)
```
    Initializes an instance using the specified asteroids.bsp filename.
    
    Parameters:
    
    filename - The full path and filename of the asteroids.bsp file.
    
    Throws:
    
    ArgumentNullException - Thrown when filename is null.
  - AsteroidsBspEphemerisProvider
```
public AsteroidsBspEphemerisProvider(@Nonnull
                                     StreamFactory streamFactory)
```
    Initializes a new instance with the specified stream factory.
    The streams created by streamFactory must support seeking. This means that the streams must implement ISeekableStream or FileInputStream.
    
    Parameters:
    
    streamFactory - The factory to use to create streams to read the JPL SPK data.
    
    Throws:
    
    ArgumentNullException - Thrown when streamFactory is null.
  - AsteroidsBspEphemerisProvider
```
public AsteroidsBspEphemerisProvider(@Nonnull
                                     JplSpkFile file)
```
    Initializes an instance using the specified JplSpkFile instance.
    
    Parameters:
    
    file - The JplSpkFile instance to use.
    
    Throws:
    
    ArgumentNullException - Thrown when file is null.
  - AsteroidsBspEphemerisProvider
```
protected AsteroidsBspEphemerisProvider(@Nonnull
                                        AsteroidsBspEphemerisProvider existingInstance,
                                        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(JplSpkEphemerisProvider 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 JplSpkEphemerisProvider
    
    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(AsteroidsBspEphemerisProvider 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 AsteroidsBspEphemerisProvider.checkForSameDefinition(agi.foundation.spice.JplSpkEphemerisProvider) method.
    
    Overrides:
    
    computeCurrentDefinitionHashCode in class JplSpkEphemerisProvider
    
    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 JplSpkEphemerisProvider
    
    Parameters:
    
    enumerator - The enumerator that is informed of the dependencies of this object.
  - freezeAggregatedObjects
```
protected void freezeAggregatedObjects()
```
    Called by 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.
    
    Overrides:
    
    freezeAggregatedObjects in class JplSpkEphemerisProvider
  - useForCentralBodyPositions
```
public void useForCentralBodyPositions(CentralBodiesFacet centralBodiesFacet)
```
    Uses this ephemeris provider for the positions of the centers of mass of Ceres and Vesta in the specified CentralBodiesFacet instance.
    To use this ephemeris provider for only Ceres or Vesta, use one of the available points. This method also calls CentralBody.synchronizeOrigins() on the Ceres and Vesta.
    
    Specified by:
    
    useForCentralBodyPositions in class JplSpkEphemerisProvider
    
    Parameters:
    
    centralBodiesFacet - The central bodies to update to use this data.
    
    Throws:
    
    ArgumentNullException - Thrown when centralBodiesFacet is null.
  - getSolarSystemBarycenter
```
@Nonnull
public final Point getSolarSystemBarycenter()
```
    Gets a point representing the location of the barycenter of the Solar System.
  - getCeresPoint
```
@Nonnull
public final Point getCeresPoint()
```
    Gets a point representing the location of Ceres.
  - getVestaPoint
```
@Nonnull
public final Point getVestaPoint()
```
    Gets a point representing the location of Vesta.
  - getPsychePoint
```
@Nonnull
public final Point getPsychePoint()
```
    Gets a point representing the location of Psyche.
  - getLutetiaPoint
```
@Nonnull
public final Point getLutetiaPoint()
```
    Gets a point representing the location of Lutetia.
  - getVirginiaPoint
```
@Nonnull
public final Point getVirginiaPoint()
```
    Gets a point representing the location of the asteroid Virginia.
  - getIdaPoint
```
@Nonnull
public final Point getIdaPoint()
```
    Gets a point representing the location of Ida.
  - getMathildePoint
```
@Nonnull
public final Point getMathildePoint()
```
    Gets a point representing the location of Mathilde.
  - getErosPoint
```
@Nonnull
public final Point getErosPoint()
```
    Gets a point representing the location of Eros.
  - getPatroclusPoint
```
@Nonnull
public final Point getPatroclusPoint()
```
    Gets a point representing the location of Patroclus.
  - getGasparaPoint
```
@Nonnull
public final Point getGasparaPoint()
```
    Gets a point representing the location of Gaspara.
  - getSteinsPoint
```
@Nonnull
public final Point getSteinsPoint()
```
    Gets a point representing the location of Steins.
  - getEurybatesPoint
```
@Nonnull
public final Point getEurybatesPoint()
```
    Gets a point representing the location of Eurybates.
  - getLeucusPoint
```
@Nonnull
public final Point getLeucusPoint()
```
    Gets a point representing the location of Leucus.
  - getPolymelePoint
```
@Nonnull
public final Point getPolymelePoint()
```
    Gets a point representing the location of Polymele.
  - getOrusPoint
```
@Nonnull
public final Point getOrusPoint()
```
    Gets a point representing the location of Orus.
  - getItokawaPoint
```
@Nonnull
public final Point getItokawaPoint()
```
    Gets a point representing the location of Itokawa.
  - getDonaldJohansonPoint
```
@Nonnull
public final Point getDonaldJohansonPoint()
```
    Gets a point representing the location of DonaldJohanson.
  - getDidymosPoint
```
@Nonnull
public final Point getDidymosPoint()
```
    Gets a point representing the location of Didymos.
  - getRyuguPoint
```
@Nonnull
public final Point getRyuguPoint()
```
    Gets a point representing the location of Ryugu.

Class AsteroidsBspEphemerisProvider

Constructor Summary

Method Summary

Methods inherited from class agi.foundation.spice.JplSpkEphemerisProvider

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

Methods inherited from class java.lang.Object

Constructor Detail

AsteroidsBspEphemerisProvider

AsteroidsBspEphemerisProvider

AsteroidsBspEphemerisProvider

Method Detail

clone

checkForSameDefinition

checkForSameDefinition

computeCurrentDefinitionHashCode

enumerateDependencies

freezeAggregatedObjects

useForCentralBodyPositions

getSolarSystemBarycenter

getCeresPoint

getVestaPoint

getPsychePoint

getLutetiaPoint

getVirginiaPoint

getIdaPoint

getMathildePoint

getErosPoint

getPatroclusPoint

getGasparaPoint

getSteinsPoint

getEurybatesPoint

getLeucusPoint

getPolymelePoint

getOrusPoint

getItokawaPoint

getDonaldJohansonPoint

getDidymosPoint

getRyuguPoint