SaturnBspEphemerisProvider Class

Provides access to the positions of the nine major moons of Saturn with respect to the Saturn system barycenter.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.SpiceJplSpkEphemerisProvider
      AGI.Foundation.SpiceSaturnBspEphemerisProvider
        AGI.Foundation.SpiceSat441BspEphemerisProvider

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

Syntax

C++

Copy

public class SaturnBspEphemerisProvider : JplSpkEphemerisProvider

Public Class SaturnBspEphemerisProvider
	Inherits JplSpkEphemerisProvider

public ref class SaturnBspEphemerisProvider : public JplSpkEphemerisProvider

type SaturnBspEphemerisProvider =  
    class
        inherit JplSpkEphemerisProvider
    end

The SaturnBspEphemerisProvider type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	DionePoint	Gets a point representing the center of mass location of the moon Dione in a reference frame centered at the current value of SaturnSystemBarycenter.
	EnceladusPoint	Gets a point representing the center of mass location of the moon Enceladus in a reference frame centered at the current value of SaturnSystemBarycenter.
	File	Gets the JPL SPK file represented by this instance. (Inherited from JplSpkEphemerisProvider.)
	HyperionPoint	Gets a point representing the center of mass location of the moon Hyperion in a reference frame centered at the current value of SaturnSystemBarycenter.
	IapetusPoint	Gets a point representing the center of mass location of the moon Iapetus in a reference frame centered at the current value of SaturnSystemBarycenter.
	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.)
	MimasPoint	Gets a point representing the center of mass location of the moon Mimas in a reference frame centered at the current value of SaturnSystemBarycenter.
	PhoebePoint	Gets a point representing the center of mass location of the moon Phoebe in a reference frame centered at the current value of SaturnSystemBarycenter.
	RheaPoint	Gets a point representing the center of mass location of the moon Rhea in a reference frame centered at the current value of SaturnSystemBarycenter.
	SaturnSystemBarycenter	Gets or sets a point representing the location of the barycenter of the Saturn planetary system. Setting this point will also cause the points in this class representing the moons of Saturn to be modeled as orbiting this updated point.
	TethysPoint	Gets a point representing the center of mass location of the moon Tethys in a reference frame centered at the current value of SaturnSystemBarycenter.
	TitanPoint	Gets a point representing the center of mass location of the moon Titan in a reference frame centered at the current value of SaturnSystemBarycenter.

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(SaturnBspEphemerisProvider)	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 centers of mass of the nine major moons of Saturn in the specified CentralBodiesFacet instance. This also sets the position of the SaturnSystemBarycenter. This does not set the position of SaturnCentralBody unless this class is also a Sat441BspEphemerisProvider and the sat441.bsp file is used. (Overrides JplSpkEphemerisProviderUseForCentralBodyPositions(CentralBodiesFacet).)

Top

Remarks

If STK is installed with the Planetary Data Supplement, the file saturn.bsp is available in the STKData/Spice folder of the STK installation. This should be used as 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 Navigation and Ancillary Information Facility (NAIF) of JPL to download the sat441.bsp ephemeris for Saturn and its moons. This file is massive (646 MB) because it contains data that extends hundreds of years into the past and future for astronomical purposes. There is a small text sat441.cmt file in that directory that contains information about what data is contained within the sat441.bsp file. While this file is compatible with this base class, it is recommended that it is used with the derived class Jup365BspEphemerisProvider instead because the derived class provides additional functionality associated with the physical center of mass of Saturn and some of the smaller moons of Saturn.

Reference

AGI.Foundation.Spice Namespace