CentralBodiesFacet

java.lang.Object
- agi.foundation.infrastructure.CalculationContextFacet
- - agi.foundation.celestial.CentralBodiesFacet

All Implemented Interfaces:

ICloneWithContext, IThreadAware, Iterable<CentralBody>
```
public class CentralBodiesFacet
extends CalculationContextFacet
implements Iterable<CentralBody>
```
A CalculationContextFacet that holds and provides information about central bodies such as planets, moons, the sun, etc.
Use the CentralBodiesFacet.getFromContext() method to obtain an instance of type, instead of constructing a new one.

This example shows how to obtain the Earth central body:
```
EarthCentralBody earth = CentralBodiesFacet.getFromContext().getEarth();
```

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CentralBodiesFacet()` Initializes a new instance with default values.
`protected`	`CentralBodiesFacet(CentralBodiesFacet existingInstance, CopyContext context)` Initializes a new instance as a copy of an existing instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Object`	`clone(CopyContext context)` Clones this object using the specified context.
`ArielCentralBody`	`getAriel()` Gets the Uranian moon Ariel.
`CentralBody`	`getByName(String name)` Gets a central body by name.
`CallistoCentralBody`	`getCallisto()` Gets the Jovian moon Callisto.
`CentralBody`	`getCentralBodyOfPoint(JulianDate date, Point point)` Gets the central body most closely associated with a given point.
`CeresCentralBody`	`getCeres()` Gets the dwarf planet Ceres.
`CharonCentralBody`	`getCharon()` Gets the Plutonian moon Charon.
`DeimosCentralBody`	`getDeimos()` Gets the Martian moon Deimos.
`DioneCentralBody`	`getDione()` Gets the Saturnian moon Dione.
`EarthCentralBody`	`getEarth()` Gets the planet Earth.
`EarthMoonBarycenter`	`getEarthMoonBarycenter()` Gets the barycenter of the Earth-Moon system.
`EnceladusCentralBody`	`getEnceladus()` Gets the Saturnian moon Enceladus.
`EuropaCentralBody`	`getEuropa()` Gets the Jovian moon Europa.
`static CentralBodiesFacet`	`getFromContext()` Gets the `CentralBodiesFacet` instance from the calculation context.
`GanymedeCentralBody`	`getGanymede()` Gets the Jovian moon Ganymede.
`HyperionCentralBody`	`getHyperion()` Gets the Saturnian moon Hyperion.
`IapetusCentralBody`	`getIapetus()` Gets the Saturnian moon Iapetus.
`IoCentralBody`	`getIo()` Gets the Jovian moon Io.
`boolean`	`getIsThreadSafe()` Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
`JupiterCentralBody`	`getJupiter()` Gets the planet Jupiter.
`JupiterSystemBarycenter`	`getJupiterSystemBarycenter()` Gets the barycenter of the Jupiter system.
`MarsCentralBody`	`getMars()` Gets the planet Mars.
`MarsSystemBarycenter`	`getMarsSystemBarycenter()` Gets the barycenter of the Mars system.
`MercuryCentralBody`	`getMercury()` Gets the planet Mercury.
`MimasCentralBody`	`getMimas()` Gets the Saturnian moon Mimas.
`MoonCentralBody`	`getMoon()` Gets the Moon.
`NeptuneCentralBody`	`getNeptune()` Gets the planet Neptune.
`NeptuneSystemBarycenter`	`getNeptuneSystemBarycenter()` Gets the barycenter of the Neptune system.
`PhobosCentralBody`	`getPhobos()` Gets the Martian moon Phobos.
`PhoebeCentralBody`	`getPhoebe()` Gets the Saturnian moon Phoebe.
`PlutoCentralBody`	`getPluto()` Gets the dwarf planet Pluto.
`PlutoSystemBarycenter`	`getPlutoSystemBarycenter()` Gets the barycenter of the Pluto system.
`RheaCentralBody`	`getRhea()` Gets the Saturnian moon Rhea.
`SaturnCentralBody`	`getSaturn()` Gets the planet Saturn.
`SaturnSystemBarycenter`	`getSaturnSystemBarycenter()` Gets the barycenter of the Saturn system.
`SolarSystemBarycenter`	`getSolarSystemBarycenter()` Gets the barycenter of the solar system.
`SunCentralBody`	`getSun()` Gets the Sun.
`TethysCentralBody`	`getTethys()` Gets the Saturnian moon Tethys.
`TitanCentralBody`	`getTitan()` Gets the Saturnian moon Titan.
`TitaniaCentralBody`	`getTitania()` Gets the Uranian moon Titania.
`TritonCentralBody`	`getTriton()` Gets the Neptunian moon Triton.
`UranusCentralBody`	`getUranus()` Gets the planet Uranus.
`UranusSystemBarycenter`	`getUranusSystemBarycenter()` Gets the barycenter of the Uranus system.
`VenusCentralBody`	`getVenus()` Gets the planet Venus.
`VestaCentralBody`	`getVesta()` Gets the asteroid Vesta.
`Iterator<CentralBody>`	`iterator()` Enumerates the central bodies.
`void`	`useInCurrentContext()` Adds this instance to the current context, making it the official instance of this facet type in the context.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Constructor Detail
  - CentralBodiesFacet
```
public CentralBodiesFacet()
```
    Initializes a new instance with default values. You should generally call the CentralBodiesFacet.getFromContext() method instead of constructing a new instance.
    A default constructed CentralBodiesFacet instance has a default constructed instance of each central body. See the documentation for the default constructor of each central body class for information about the defaults. For example, see EarthCentralBody.EarthCentralBody() and SunCentralBody.SunCentralBody().
    
    You should generally call the CentralBodiesFacet.getFromContext() method instead of constructing a new instance. This example shows how to obtain the Earth central body using CentralBodiesFacet.getFromContext():
```
EarthCentralBody earth = CentralBodiesFacet.getFromContext().getEarth();
```
  - CentralBodiesFacet
```
protected CentralBodiesFacet(@Nonnull
                             CentralBodiesFacet existingInstance,
                             @Nonnull
                             CopyContext context)
```
    Initializes a new instance as a copy of an existing instance.
    See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor in a derived class.
    
    Parameters:
    
    existingInstance - The existing instance to copy.
    
    context - A CopyContext that controls the depth of the copy.
    
    Throws:
    
    ArgumentNullException - Thrown when existingInstance or context is null.
- Method Detail
  - clone
```
public Object clone(CopyContext context)
```
    Clones this object using the specified context.
    
    This method should be implemented to call a copy constructor on the class of the object being cloned. The copy constructor should take the CopyContext as a parameter in addition to the existing instance to copy. The copy constructor should first call CopyContext.addObjectMapping(T, T) to identify the newly constructed instance as a copy of the existing instance. It should then copy all fields, using CopyContext.updateReference(T) to copy any reference fields.
    
    A typical implementation of ICloneWithContext:
```
public static class MyClass implements ICloneWithContext {
    public MyClass(MyClass existingInstance, CopyContext context) {
        context.addObjectMapping(existingInstance, this);
        someReference = context.updateReference(existingInstance.someReference);
    }

    @Override
    public final Object clone(CopyContext context) {
        return new MyClass(this, context);
    }

    private Object someReference;
}
```
    In general, all fields that are reference types should be copied with a call to CopyContext.updateReference(T). There are a couple of exceptions:
    1. Fields that are aggregate parts of the object should always be copied. A referenced object is an aggregate if properties or methods on the object being copied can modify the externally-visible value of the referenced object.
    2. If the semantics of the referenced object require that it have a single parent, owner, context, etc., and the object being copied is that parent, owner, or context, then the referenced object should always be copied.
    If one of these exceptions applies, the CopyContext should be given an opportunity to update the reference before the reference is copied explicitly. Use CopyContext.updateReference(T) to update the reference. If CopyContext.updateReference(T) returns the original object, indicating that the context does not have a replacement registered, then copy the object manually by invoking a Clone method, a copy constructor, or by manually constructing a new instance and copying the values.
```
alwaysCopy = context.updateReference(existingInstance.alwaysCopy);
if (existingInstance.alwaysCopy != null && alwaysCopy == existingInstance.alwaysCopy) {
    alwaysCopy = (AlwaysCopy) existingInstance.alwaysCopy.clone(context);
}
```
    If you are implementing an evaluator (a class that implements IEvaluator), the IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) method shares some responsibilities with the copy context constructor. Code duplication can be avoided by doing the following:
    1. For references to other evaluators ONLY, simply assign the reference in the constructor instead of calling CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to non-evaluators.
    2. Call IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the same CopyContext passed to the constructor.
    3. Implement IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as normal. See the reference documentation for IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) for more information on implementing that method.
```
public MyClass(MyClass existingInstance, CopyContext context) {
    super(existingInstance, context);
    someReference = context.updateReference(existingInstance.someReference);
    evaluatorReference = existingInstance.evaluatorReference;
    updateEvaluatorReferences(context);
}

@Override
public void updateEvaluatorReferences(CopyContext context) {
    evaluatorReference = context.updateReference(evaluatorReference);
}

@Override
public Object clone(CopyContext context) {
    return new MyClass(this, context);
}

private Object someReference;
private IEvaluator evaluatorReference;
```
    Specified by:
    
    clone in interface ICloneWithContext
    
    Specified by:
    
    clone in class CalculationContextFacet
    
    Parameters:
    
    context - The context to use to perform the copy.
    
    Returns:
    
    A new instance which is a copy of this object.
  - getIsThreadSafe
```
public boolean getIsThreadSafe()
```
    Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
    
    If this property is true, all methods and properties are guaranteed to be thread safe. Conceptually, an object that returns true for this method acts as if there is a lock protecting each method and property such that only one thread at a time can be inside any method or property in the class. In reality, such locks are generally not used and are in fact discouraged. However, the user must not experience any exceptions or inconsistent behavior that would not be experienced if such locks were used.
    
    If this property is false, the behavior when using this class from multiple threads simultaneously is undefined and may include inconsistent results and exceptions. Clients wishing to use multiple threads should call CopyForAnotherThread.copy(T) to get a separate instance of the object for each thread.
    
    Specified by:
    
    getIsThreadSafe in interface IThreadAware
    
    Specified by:
    
    getIsThreadSafe in class CalculationContextFacet
  - getFromContext
```
@Nonnull
public static CentralBodiesFacet getFromContext()
```
    Gets the CentralBodiesFacet instance from the calculation context. If the context does not contain a CentralBodiesFacet instance, one will be created.
    This example shows how to obtain the Earth central body:
```
EarthCentralBody earth = CentralBodiesFacet.getFromContext().getEarth();
```
    If a CentralBodiesFacet instance does not already exist in the CalculationContext, a default one is created. The default CentralBodiesFacet instance has a default constructed instance of each central body. See the documentation for the default constructor of each central body class for information about the defaults. For example, see EarthCentralBody.EarthCentralBody() and SunCentralBody.SunCentralBody().
    Returns:
    
    The instance from the context.
  - getSolarSystemBarycenter
```
@Nonnull
public final SolarSystemBarycenter getSolarSystemBarycenter()
```
    Gets the barycenter of the solar system.
  - getSun
```
@Nonnull
public final SunCentralBody getSun()
```
    Gets the Sun.
  - getMoon
```
@Nonnull
public final MoonCentralBody getMoon()
```
    Gets the Moon.
  - getEarth
```
@Nonnull
public final EarthCentralBody getEarth()
```
    Gets the planet Earth.
  - getMercury
```
@Nonnull
public final MercuryCentralBody getMercury()
```
    Gets the planet Mercury.
  - getVenus
```
@Nonnull
public final VenusCentralBody getVenus()
```
    Gets the planet Venus.
  - getMars
```
@Nonnull
public final MarsCentralBody getMars()
```
    Gets the planet Mars.
  - getJupiter
```
@Nonnull
public final JupiterCentralBody getJupiter()
```
    Gets the planet Jupiter.
  - getSaturn
```
@Nonnull
public final SaturnCentralBody getSaturn()
```
    Gets the planet Saturn.
  - getUranus
```
@Nonnull
public final UranusCentralBody getUranus()
```
    Gets the planet Uranus.
  - getNeptune
```
@Nonnull
public final NeptuneCentralBody getNeptune()
```
    Gets the planet Neptune.
  - getPluto
```
@Nonnull
public final PlutoCentralBody getPluto()
```
    Gets the dwarf planet Pluto.
  - getCeres
```
@Nonnull
public final CeresCentralBody getCeres()
```
    Gets the dwarf planet Ceres.
  - getVesta
```
@Nonnull
public final VestaCentralBody getVesta()
```
    Gets the asteroid Vesta.
  - getPhobos
```
@Nonnull
public final PhobosCentralBody getPhobos()
```
    Gets the Martian moon Phobos.
  - getDeimos
```
@Nonnull
public final DeimosCentralBody getDeimos()
```
    Gets the Martian moon Deimos.
  - getIo
```
@Nonnull
public final IoCentralBody getIo()
```
    Gets the Jovian moon Io.
  - getEuropa
```
@Nonnull
public final EuropaCentralBody getEuropa()
```
    Gets the Jovian moon Europa.
  - getGanymede
```
@Nonnull
public final GanymedeCentralBody getGanymede()
```
    Gets the Jovian moon Ganymede.
  - getCallisto
```
@Nonnull
public final CallistoCentralBody getCallisto()
```
    Gets the Jovian moon Callisto.
  - getMimas
```
@Nonnull
public final MimasCentralBody getMimas()
```
    Gets the Saturnian moon Mimas.
  - getEnceladus
```
@Nonnull
public final EnceladusCentralBody getEnceladus()
```
    Gets the Saturnian moon Enceladus.
  - getTethys
```
@Nonnull
public final TethysCentralBody getTethys()
```
    Gets the Saturnian moon Tethys.
  - getDione
```
@Nonnull
public final DioneCentralBody getDione()
```
    Gets the Saturnian moon Dione.
  - getRhea
```
@Nonnull
public final RheaCentralBody getRhea()
```
    Gets the Saturnian moon Rhea.
  - getTitan
```
@Nonnull
public final TitanCentralBody getTitan()
```
    Gets the Saturnian moon Titan.
  - getHyperion
```
@Nonnull
public final HyperionCentralBody getHyperion()
```
    Gets the Saturnian moon Hyperion.
  - getIapetus
```
@Nonnull
public final IapetusCentralBody getIapetus()
```
    Gets the Saturnian moon Iapetus.
  - getPhoebe
```
@Nonnull
public final PhoebeCentralBody getPhoebe()
```
    Gets the Saturnian moon Phoebe.
  - getAriel
```
@Nonnull
public final ArielCentralBody getAriel()
```
    Gets the Uranian moon Ariel.
  - getTitania
```
@Nonnull
public final TitaniaCentralBody getTitania()
```
    Gets the Uranian moon Titania.
  - getTriton
```
@Nonnull
public final TritonCentralBody getTriton()
```
    Gets the Neptunian moon Triton.
  - getCharon
```
@Nonnull
public final CharonCentralBody getCharon()
```
    Gets the Plutonian moon Charon.
  - getEarthMoonBarycenter
```
@Nonnull
public final EarthMoonBarycenter getEarthMoonBarycenter()
```
    Gets the barycenter of the Earth-Moon system.
  - getMarsSystemBarycenter
```
@Nonnull
public final MarsSystemBarycenter getMarsSystemBarycenter()
```
    Gets the barycenter of the Mars system.
  - getJupiterSystemBarycenter
```
@Nonnull
public final JupiterSystemBarycenter getJupiterSystemBarycenter()
```
    Gets the barycenter of the Jupiter system.
  - getSaturnSystemBarycenter
```
@Nonnull
public final SaturnSystemBarycenter getSaturnSystemBarycenter()
```
    Gets the barycenter of the Saturn system.
  - getUranusSystemBarycenter
```
@Nonnull
public final UranusSystemBarycenter getUranusSystemBarycenter()
```
    Gets the barycenter of the Uranus system.
  - getNeptuneSystemBarycenter
```
@Nonnull
public final NeptuneSystemBarycenter getNeptuneSystemBarycenter()
```
    Gets the barycenter of the Neptune system.
  - getPlutoSystemBarycenter
```
@Nonnull
public final PlutoSystemBarycenter getPlutoSystemBarycenter()
```
    Gets the barycenter of the Pluto system.
  - useInCurrentContext
```
public void useInCurrentContext()
```
    Adds this instance to the current context, making it the official instance of this facet type in the context.
    
    Specified by:
    
    useInCurrentContext in class CalculationContextFacet
  - getByName
```
@Nullable
public final CentralBody getByName(@Nonnull
                                              String name)
```
    Gets a central body by name.
    
    Parameters:
    
    name - The name of the central body to get.
    
    Returns:
    
    The central body instance, or null if a central body with the specified name does not exist.
  - getCentralBodyOfPoint
```
@Nullable
public final CentralBody getCentralBodyOfPoint(@Nonnull
                                                          JulianDate date,
                                                          Point point)
```
    Gets the central body most closely associated with a given point.
    This method traverses the DefinedInIntervals (get) chain until it finds the center of mass point of a central body, and returns that central body. If a central body center of mass point is not found, this method returns null.
    
    Parameters:
    
    date - The date at which to obtain the central body, in case the point is defined in different reference frames at different times.
    
    point - The point.
    
    Returns:
    
    The central body that is most closely associated with the point.
  - iterator
```
public final Iterator<CentralBody> iterator()
```
    Enumerates the central bodies.
    
    Specified by:
    
    iterator in interface Iterable<CentralBody>
    
    Returns:
    
    An enumerator for enumerating the central bodies.

Class CentralBodiesFacet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

CentralBodiesFacet

Method Detail

clone

getIsThreadSafe

getFromContext

getSolarSystemBarycenter

getSun

getMoon

getEarth

getMercury

getVenus

getMars

getJupiter

getSaturn

getUranus

getNeptune

getPluto

getCeres

getVesta

getPhobos

getDeimos

getIo

getEuropa

getGanymede

getCallisto

getMimas

getEnceladus

getTethys

getDione

getRhea

getTitan

getHyperion

getIapetus

getPhoebe

getAriel

getTitania

getTriton

getCharon

getEarthMoonBarycenter

getMarsSystemBarycenter

getJupiterSystemBarycenter

getSaturnSystemBarycenter

getUranusSystemBarycenter

getNeptuneSystemBarycenter

getPlutoSystemBarycenter

useInCurrentContext

getByName

getCentralBodyOfPoint

iterator