Click or drag to resize

AsteroidsBspEphemerisProvider Class

Provides access to the positions of asteroids with respect to the Solar System barycenter.
Inheritance Hierarchy

Namespace:  AGI.Foundation.Spice
Assembly:  AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax
public class AsteroidsBspEphemerisProvider : JplSpkEphemerisProvider

The AsteroidsBspEphemerisProvider type exposes the following members.

Constructors
  NameDescription
Public methodAsteroidsBspEphemerisProvider(JplSpkFile)
Initializes an instance using the specified JplSpkFile instance.
Public methodAsteroidsBspEphemerisProvider(StreamFactory)
Initializes a new instance with the specified stream factory.
Public methodAsteroidsBspEphemerisProvider(String)
Initializes an instance using the specified asteroids.bsp filename.
Protected methodAsteroidsBspEphemerisProvider(AsteroidsBspEphemerisProvider, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyCeresPoint
Gets a point representing the location of Ceres.
Public propertyDidymosPoint
Gets a point representing the location of Didymos.
Public propertyDonaldJohansonPoint
Gets a point representing the location of DonaldJohanson.
Public propertyErosPoint
Gets a point representing the location of Eros.
Public propertyEurybatesPoint
Gets a point representing the location of Eurybates.
Public propertyFile
Gets the JPL SPK file represented by this instance.
(Inherited from JplSpkEphemerisProvider.)
Public propertyGasparaPoint
Gets a point representing the location of Gaspara.
Public propertyIdaPoint
Gets a point representing the location of Ida.
Public propertyIsFrozen
Gets a value indicating whether this object is frozen. A frozen object cannot be modified and an ObjectFrozenException will be thrown if an attempt is made to do so.
(Inherited from DefinitionalObject.)
Public propertyItokawaPoint
Gets a point representing the location of Itokawa.
Public propertyLeucusPoint
Gets a point representing the location of Leucus.
Public propertyLutetiaPoint
Gets a point representing the location of Lutetia.
Public propertyMathildePoint
Gets a point representing the location of Mathilde.
Public propertyOrusPoint
Gets a point representing the location of Orus.
Public propertyPatroclusPoint
Gets a point representing the location of Patroclus.
Public propertyPolymelePoint
Gets a point representing the location of Polymele.
Public propertyPsychePoint
Gets a point representing the location of Psyche.
Public propertyRyuguPoint
Gets a point representing the location of Ryugu.
Public propertySolarSystemBarycenter
Gets a point representing the location of the barycenter of the Solar System.
Public propertySteinsPoint
Gets a point representing the location of Steins.
Public propertyVestaPoint
Gets a point representing the location of Vesta.
Public propertyVirginiaPoint
Gets a point representing the location of the asteroid Virginia.
Top
Methods
  NameDescription
Protected methodCheckForSameDefinition(AsteroidsBspEphemerisProvider)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
Protected methodCheckForSameDefinition(DefinitionalObject)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Inherited from JplSpkEphemerisProvider.)
Protected methodCheckForSameDefinition(JplSpkEphemerisProvider)
Checks to determine if another instance has the same definition as this instance and returns 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 for all derived-class instances. Derived classes should check the type of other to preserve the symmetric nature of IsSameDefinition(Object).
(Overrides JplSpkEphemerisProviderCheckForSameDefinition(JplSpkEphemerisProvider).)
Public methodClone
Clones this object using the specified context.
(Overrides DefinitionalObjectClone(CopyContext).)
Protected methodComputeCurrentDefinitionHashCode
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 CheckForSameDefinition(DefinitionalObject) method.
(Overrides JplSpkEphemerisProviderComputeCurrentDefinitionHashCode.)
Public methodEnumerateDependencies
Enumerates the dependencies of this object by calling EnumerateT(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.
(Overrides JplSpkEphemerisProviderEnumerateDependencies(DependencyEnumerator).)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodFreeze
Freezes this object. Further attempts to modify it will result in an ObjectFrozenException.
(Inherited from DefinitionalObject.)
Protected methodFreezeAggregatedObjects
Called by 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 JplSpkEphemerisProviderFreezeAggregatedObjects.)
Public methodGetDefinitionHashCode
Gets a hash code representing the definition of this object.
(Inherited from DefinitionalObject.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsSameDefinition
Determines if this object has the same definition as another object.
(Inherited from DefinitionalObject.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfFrozen
Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object.
(Inherited from DefinitionalObject.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUseForCentralBodyPositions
Uses this ephemeris provider for the positions of the centers of mass of Ceres and Vesta in the specified CentralBodiesFacet instance.
(Overrides JplSpkEphemerisProviderUseForCentralBodyPositions(CentralBodiesFacet).)
Top
Remarks

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.

See Also