CeresBspEphemerisProvider Class

Provides access to the position of Ceres with respect to the Sun.

Inheritance Hierarchy

SystemObject
  AGI.Foundation.InfrastructureDefinitionalObject
    AGI.Foundation.SpiceJplSpkEphemerisProvider
      AGI.Foundation.SpiceCeresBspEphemerisProvider

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 CeresBspEphemerisProvider : JplSpkEphemerisProvider

Public Class CeresBspEphemerisProvider
	Inherits JplSpkEphemerisProvider

public ref class CeresBspEphemerisProvider : public JplSpkEphemerisProvider

type CeresBspEphemerisProvider =  
    class
        inherit JplSpkEphemerisProvider
    end

The CeresBspEphemerisProvider type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	CeresPoint	Gets a point representing the center of mass location of the dwarf planet Ceres in a reference frame centered at the current value of SunPoint.
	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.)
	SunPoint	Gets or sets a point representing the location of the Sun. Setting this point will also cause the point in this class representing Ceres to be modeled as orbiting this updated point.

Top

Methods

	Name	Description
	CheckForSameDefinition(CeresBspEphemerisProvider)	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).
	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).)
	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 position of the center of mass of Ceres in the specified CentralBodiesFacet instance. This also sets the position of the Sun. (Overrides JplSpkEphemerisProviderUseForCentralBodyPositions(CentralBodiesFacet).)

Top

Remarks

The ceres.bsp ephemeris file can be created using the website of the Solar System Dynamics (SSD) group of JPL to build your own ceres.bsp files for Ceres. First, the target body needs to be set to Ceres 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 2000001.bsp ephemeris for Ceres. Go to your local Downloads folder and rename the file to ceres.bsp. This file can then be used with this class to provide ephemeris for asteroids.

Reference

AGI.Foundation.Spice Namespace