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

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.SpiceJplSpkEphemerisProvider
      AGI.Foundation.SpicePlanetsBspEphemerisProvider

Namespace: AGI.Foundation.Spice
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.1.418.0 (24.1.418.0)

Syntax

C++

Copy

public class PlanetsBspEphemerisProvider : JplSpkEphemerisProvider

Public Class PlanetsBspEphemerisProvider
	Inherits JplSpkEphemerisProvider

public ref class PlanetsBspEphemerisProvider : public JplSpkEphemerisProvider

type PlanetsBspEphemerisProvider =  
    class
        inherit JplSpkEphemerisProvider
    end

The PlanetsBspEphemerisProvider type exposes the following members.

Constructors

	Name	Description
	PlanetsBspEphemerisProvider(JplSpkFile)	Initializes an instance using the specified JplSpkFile instance.
	PlanetsBspEphemerisProvider(StreamFactory)	Initializes a new instance with the specified stream factory.
	PlanetsBspEphemerisProvider(String)	Initializes an instance using the specified planets.bsp filename.
	PlanetsBspEphemerisProvider(PlanetsBspEphemerisProvider, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	EarthMoonBarycenter	Gets a point representing the location of the barycenter of the Earth-Moon system.
	EarthPoint	Gets a point representing the location of Earth.
	File	Gets the JPL SPK file represented by this instance. (Inherited from JplSpkEphemerisProvider.)
	IsFrozen	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.)
	JupiterPoint	Gets a point representing the location of Jupiter.
	JupiterSystemBarycenter	Gets a point representing the location of the barycenter of the Jupiter system.
	MarsPoint	Gets a point representing the location of Mars (which is identical to the position of the Mars system barycenter in this model).
	MarsSystemBarycenter	Gets a point representing the location of the barycenter of the Mars system.
	MercuryPoint	Gets a point representing the location of Mercury.
	MoonPoint	Gets a point representing the location of the Moon.
	NeptunePoint	Gets a point representing the location of Neptune.
	NeptuneSystemBarycenter	Gets a point representing the location of the barycenter of the Neptune system.
	PlutoPoint	Gets a point representing the location of Pluto.
	PlutoSystemBarycenter	Gets a point representing the location of the barycenter of the Pluto system.
	SaturnPoint	Gets a point representing the location of Saturn.
	SaturnSystemBarycenter	Gets a point representing the location of the barycenter of the Saturn system.
	SolarSystemBarycenter	Gets a point representing the location of the barycenter of the Solar System.
	SunPoint	Gets a point representing the location of the Sun.
	UranusPoint	Gets a point representing the location of Uranus.
	UranusSystemBarycenter	Gets a point representing the location of the barycenter of the Uranus system.
	VenusPoint	Gets a point representing the location of Venus.

Top

Methods

	Name	Description
	CheckForSameDefinition(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.)
	CheckForSameDefinition(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).)
	CheckForSameDefinition(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).
	Clone	Clones this object using the specified context. (Overrides DefinitionalObjectClone(CopyContext).)
	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 CheckForSameDefinition(DefinitionalObject) method. (Overrides JplSpkEphemerisProviderComputeCurrentDefinitionHashCode.)
	EnumerateDependencies	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).)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	Freeze	Freezes this object. Further attempts to modify it will result in an ObjectFrozenException. (Inherited from DefinitionalObject.)
	FreezeAggregatedObjects	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.)
	GetDefinitionHashCode	Gets a hash code representing the definition of this object. (Inherited from DefinitionalObject.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsSameDefinition	Determines if this object has the same definition as another object. (Inherited from DefinitionalObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ThrowIfFrozen	Throws ObjectFrozenException if this object IsFrozen. This method should be called from any method or property that modifies this object. (Inherited from DefinitionalObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UseForCentralBodyPositions	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.

Reference

AGI.Foundation.Spice Namespace