Click or drag to resize

PlanetsBspEphemerisProvider Class

Provides access to the positions of the Sun and planetary system barycenters with respect to the Solar System barycenter. Also, provides access to the positions of planets with respect to their planetary system barycenters.
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 PlanetsBspEphemerisProvider : JplSpkEphemerisProvider

The PlanetsBspEphemerisProvider type exposes the following members.

Constructors
  NameDescription
Public methodPlanetsBspEphemerisProvider(JplSpkFile)
Initializes an instance using the specified JplSpkFile instance.
Public methodPlanetsBspEphemerisProvider(StreamFactory)
Initializes a new instance with the specified stream factory.
Public methodPlanetsBspEphemerisProvider(String)
Initializes an instance using the specified planets.bsp filename.
Protected methodPlanetsBspEphemerisProvider(PlanetsBspEphemerisProvider, CopyContext)
Initializes a new instance as a copy of an existing instance.
Top
Properties
  NameDescription
Public propertyEarthMoonBarycenter
Gets a point representing the location of the barycenter of the Earth-Moon system.
Public propertyEarthPoint
Gets a point representing the location of Earth.
Public propertyFile
Gets the JPL SPK file represented by this instance.
(Inherited from JplSpkEphemerisProvider.)
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 propertyJupiterPoint
Gets a point representing the location of Jupiter.
Public propertyJupiterSystemBarycenter
Gets a point representing the location of the barycenter of the Jupiter system.
Public propertyMarsPoint
Gets a point representing the location of Mars (which is identical to the position of the Mars system barycenter in this model).
Public propertyMarsSystemBarycenter
Gets a point representing the location of the barycenter of the Mars system.
Public propertyMercuryPoint
Gets a point representing the location of Mercury.
Public propertyMoonPoint
Gets a point representing the location of the Moon.
Public propertyNeptunePoint
Gets a point representing the location of Neptune.
Public propertyNeptuneSystemBarycenter
Gets a point representing the location of the barycenter of the Neptune system.
Public propertyPlutoPoint
Gets a point representing the location of Pluto.
Public propertyPlutoSystemBarycenter
Gets a point representing the location of the barycenter of the Pluto system.
Public propertySaturnPoint
Gets a point representing the location of Saturn.
Public propertySaturnSystemBarycenter
Gets a point representing the location of the barycenter of the Saturn system.
Public propertySolarSystemBarycenter
Gets a point representing the location of the barycenter of the Solar System.
Public propertySunPoint
Gets a point representing the location of the Sun.
Public propertyUranusPoint
Gets a point representing the location of Uranus.
Public propertyUranusSystemBarycenter
Gets a point representing the location of the barycenter of the Uranus system.
Public propertyVenusPoint
Gets a point representing the location of Venus.
Top
Methods
  NameDescription
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).)
Protected methodCheckForSameDefinition(PlanetsBspEphemerisProvider)
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).
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 Sun, planetary barycenters, planets, Pluto, and the Moon. in the specified CentralBodiesFacet instance.
(Overrides JplSpkEphemerisProviderUseForCentralBodyPositions(CentralBodiesFacet).)
Top
Remarks

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 UseForCentralBodyPositions(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.

See Also