CentralBodiesFacet Class

A CalculationContextFacet that holds and provides information about central bodies such as planets, moons, the sun, etc.

Inheritance Hierarchy

SystemObject
AGI.Foundation.InfrastructureCalculationContextFacet
AGI.Foundation.CelestialCentralBodiesFacet

Namespace: AGI.Foundation.Celestial
Assembly: AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)

Syntax

C++

Copy

public class CentralBodiesFacet : CalculationContextFacet, 
	IEnumerable<CentralBody>, IEnumerable

Public Class CentralBodiesFacet
	Inherits CalculationContextFacet
	Implements IEnumerable(Of CentralBody), IEnumerable

public ref class CentralBodiesFacet : public CalculationContextFacet, 
	IEnumerable<CentralBody^>, IEnumerable

type CentralBodiesFacet =  
    class
        inherit CalculationContextFacet
        interface IEnumerable<CentralBody>
        interface IEnumerable
    end

The CentralBodiesFacet type exposes the following members.

Constructors

	Name	Description
	CentralBodiesFacet	Initializes a new instance with default values. You should generally call the GetFromContext method instead of constructing a new instance.
	CentralBodiesFacet(CentralBodiesFacet, CopyContext)	Initializes a new instance as a copy of an existing instance.

Top

Properties

	Name	Description
	Ariel	Gets the Uranian moon Ariel.
	Callisto	Gets the Jovian moon Callisto.
	Ceres	Gets the dwarf planet Ceres.
	Charon	Gets the Plutonian moon Charon.
	Deimos	Gets the Martian moon Deimos.
	Dione	Gets the Saturnian moon Dione.
	Earth	Gets the planet Earth.
	EarthMoonBarycenter	Gets the barycenter of the Earth-Moon system.
	Enceladus	Gets the Saturnian moon Enceladus.
	Europa	Gets the Jovian moon Europa.
	Ganymede	Gets the Jovian moon Ganymede.
	Hyperion	Gets the Saturnian moon Hyperion.
	Iapetus	Gets the Saturnian moon Iapetus.
	Io	Gets the Jovian moon Io.
	IsThreadSafe	Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously. (Overrides CalculationContextFacetIsThreadSafe.)
	Jupiter	Gets the planet Jupiter.
	JupiterSystemBarycenter	Gets the barycenter of the Jupiter system.
	Mars	Gets the planet Mars.
	MarsSystemBarycenter	Gets the barycenter of the Mars system.
	Mercury	Gets the planet Mercury.
	Mimas	Gets the Saturnian moon Mimas.
	Moon	Gets the Moon.
	Neptune	Gets the planet Neptune.
	NeptuneSystemBarycenter	Gets the barycenter of the Neptune system.
	Phobos	Gets the Martian moon Phobos.
	Phoebe	Gets the Saturnian moon Phoebe.
	Pluto	Gets the dwarf planet Pluto.
	PlutoSystemBarycenter	Gets the barycenter of the Pluto system.
	Rhea	Gets the Saturnian moon Rhea.
	Saturn	Gets the planet Saturn.
	SaturnSystemBarycenter	Gets the barycenter of the Saturn system.
	SolarSystemBarycenter	Gets the barycenter of the solar system.
	Sun	Gets the Sun.
	Tethys	Gets the Saturnian moon Tethys.
	Titan	Gets the Saturnian moon Titan.
	Titania	Gets the Uranian moon Titania.
	Triton	Gets the Neptunian moon Triton.
	Uranus	Gets the planet Uranus.
	UranusSystemBarycenter	Gets the barycenter of the Uranus system.
	Venus	Gets the planet Venus.
	Vesta	Gets the asteroid Vesta.

Top

Methods

	Name	Description
	Clone	Clones this object using the specified context. (Overrides CalculationContextFacetClone(CopyContext).)
	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.)
	GetByName	Gets a central body by name.
	GetCentralBodyOfPoint	Gets the central body most closely associated with a given point.
	GetEnumerator	Enumerates the central bodies.
	GetFromContext	Gets the CentralBodiesFacet instance from the calculation context. If the context does not contain a CentralBodiesFacet instance, one will be created.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UseInCurrentContext	Adds this instance to the current context, making it the official instance of this facet type in the context. (Overrides CalculationContextFacetUseInCurrentContext.)

Top

Remarks

Use the GetFromContext method to obtain an instance of type, instead of constructing a new one.

Examples

This example shows how to obtain the Earth central body:

Copy

EarthCentralBody earth = CentralBodiesFacet.GetFromContext().Earth;

Reference

AGI.Foundation.Celestial Namespace