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: 22.2.414.0 (22.2.414.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
	Earth	Gets the planet Earth.
	IsThreadSafe	Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously. (Overrides CalculationContextFacetIsThreadSafe.)
	Moon	Gets the Moon.
	SolarSystemBarycenter	Gets the barycenter of the solar system.
	Sun	Gets the Sun.

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