public class CentralBodiesFacet extends CalculationContextFacet implements Iterable<CentralBody>
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();| 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.
|
| Modifier and Type | Method and Description |
|---|---|
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
CentralBody |
getByName(String name)
Gets a central body by name.
|
CentralBody |
getCentralBodyOfPoint(JulianDate date,
Point point)
Gets the central body most closely associated with a given point.
|
EarthCentralBody |
getEarth()
Gets the planet Earth.
|
static CentralBodiesFacet |
getFromContext()
Gets the
CentralBodiesFacet instance from the calculation context. |
boolean |
getIsThreadSafe()
Gets a value indicating whether the methods on this instance are safe to call from
multiple threads simultaneously.
|
MoonCentralBody |
getMoon()
Gets the Moon.
|
SolarSystemBarycenter |
getSolarSystemBarycenter()
Gets the barycenter of the solar system.
|
SunCentralBody |
getSun()
Gets the Sun.
|
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.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitforEach, spliteratorpublic CentralBodiesFacet()
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();protected CentralBodiesFacet(@Nonnull CentralBodiesFacet existingInstance, @Nonnull CopyContext context)
See ICloneWithContext.clone(CopyContext) for more information about how to implement this constructor
in a derived class.
existingInstance - The existing instance to copy.context - A CopyContext that controls the depth of the copy.ArgumentNullException - Thrown when existingInstance or context is null.public Object clone(CopyContext 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:
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:
CopyContext.updateReference(T). You should still call CopyContext.updateReference(T) on any references to
non-evaluators.
IEvaluator.updateEvaluatorReferences(agi.foundation.infrastructure.CopyContext) as the last line in the constructor and pass it the
same CopyContext passed to the constructor.
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;clone in interface ICloneWithContextclone in class CalculationContextFacetcontext - The context to use to perform the copy.public boolean getIsThreadSafe()
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.
getIsThreadSafe in interface IThreadAwaregetIsThreadSafe in class CalculationContextFacet@Nonnull public static CentralBodiesFacet getFromContext()
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().
@Nonnull public final SolarSystemBarycenter getSolarSystemBarycenter()
@Nonnull public final SunCentralBody getSun()
@Nonnull public final MoonCentralBody getMoon()
@Nonnull public final EarthCentralBody getEarth()
public void useInCurrentContext()
useInCurrentContext in class CalculationContextFacet@Nullable public final CentralBody getByName(@Nonnull String name)
name - The name of the central body to get.@Nullable public final CentralBody getCentralBodyOfPoint(@Nonnull JulianDate date, Point 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.
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.public final Iterator<CentralBody> iterator()
iterator in interface Iterable<CentralBody>