public class MercuryCentralBody extends CentralBody implements IProvideNaifIdCode
CentralBodiesFacet instance in the calculation context instead of creating one directly.
See MercuryCentralBody.MercuryCentralBody() for a description of the default instance of this class
that is found in the CalculationContext.
| Modifier and Type | Field and Description |
|---|---|
static double |
Iau2015MercuryMajorAxis
Shape values are from "Report of the IAU/IAG Working Group on Cartographic Coordinates
and Rotational Elements: 2015", Celestial Mechanics Dyn Astry 130:22, 2018.
|
static double |
Iau2015MercuryMinorAxis
Shape values are from "Report of the IAU/IAG Working Group on Cartographic Coordinates
and Rotational Elements: 2015", Celestial Mechanics Dyn Astry 130:22, 2018.
|
| Modifier | Constructor and Description |
|---|---|
|
MercuryCentralBody()
Initializes a new instance.
|
protected |
MercuryCentralBody(MercuryCentralBody existingInstance,
CopyContext context)
Initializes a new instance as a copy of an existing instance.
|
| Modifier and Type | Method and Description |
|---|---|
protected boolean |
checkForSameDefinition(CentralBody other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
protected boolean |
checkForSameDefinition(MercuryCentralBody other)
Checks to determine if another instance has the same definition as this instance and
returns
true if it does. |
Object |
clone(CopyContext context)
Clones this object using the specified context.
|
protected int |
computeCurrentDefinitionHashCode()
Computes a hash code based on the current properties of this object.
|
void |
enumerateDependencies(DependencyEnumerator enumerator)
Enumerates the dependencies of this object by calling
DependencyEnumerator#enumerate(T) for each object that this object directly depends upon. |
Point |
getCenterOfMassPoint()
Gets a point describing the center of mass of this central body.
|
ReferenceFrame |
getFixedFrame()
Gets the default Fixed frame that corresponds to the surface features of this central body.
|
ReferenceFrame |
getInertialFrame()
Gets the default Inertial frame for this central body.
|
int |
getNaifIdCode()
Gets the NAIF identification code of this central body,
barycenter, spacecraft, ground station, or other physical
object or location.
|
String |
getName()
Gets the name of the central body.
|
ReferenceFrame |
getPrincipalFrame()
Gets the default Fixed frame that corresponds to the gravity frame of this central body.
|
Ellipsoid |
getShape()
Gets the shape of this central body.
|
void |
setCenterOfMassPoint(Point value)
Sets a point describing the center of mass of this central body.
|
void |
setFixedFrame(ReferenceFrame value)
Sets the default Fixed frame that corresponds to the surface features of this central body.
|
void |
setInertialFrame(ReferenceFrame value)
Sets the default Inertial frame for this central body.
|
void |
setName(String value)
Sets the name of the central body.
|
void |
setPrincipalFrame(ReferenceFrame value)
Sets the default Fixed frame that corresponds to the gravity frame of this central body.
|
void |
setShape(Ellipsoid value)
Sets the shape of this central body.
|
void |
synchronizeOrigins()
|
checkForSameDefinition, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getIsThreadSafe, getLocationPoint, getOrientationAxes, getReferenceFrame, getService, observeCartographicPoint, observeCartographicPointareSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozenpublic static final double Iau2015MercuryMajorAxis
public static final double Iau2015MercuryMinorAxis
public MercuryCentralBody()
You should generally obtain an instance of this class from the
CentralBodiesFacet instance in the calculation context instead of creating one directly.
A default-constructed instance of MercuryCentralBody has the following
characteristics:
CenterOfMassPoint (get / set) is defined by Mercury (get).
Consider using JplDE.useForCentralBodyPositions(agi.foundation.celestial.CentralBodiesFacet) to configure this and other
central bodies with a much more accurate model of their positions using JPL DE data.
Shape (get / set) is an oblate spheroid by default that uses MercuryCentralBody.Iau2015MercuryMajorAxis as the equatorial
radius and MercuryCentralBody.Iau2015MercuryMinorAxis as the polar radius.
InertialFrame (get / set) uses the CentralBodyInertialAxes with the
Iau2015Orientation.computeMercury(agi.foundation.time.JulianDate) orientation function.
FixedFrame (get / set) and PrincipalFrame (get / set) use the IAU/IAG working group 2015 report.
See Iau2015Orientation for additional details on this orientation information.
protected MercuryCentralBody(@Nonnull MercuryCentralBody 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 DefinitionalObjectcontext - The context to use to perform the copy.protected final boolean checkForSameDefinition(CentralBody other)
true 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 false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).checkForSameDefinition in class CentralBodyother - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected boolean checkForSameDefinition(MercuryCentralBody other)
true 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 false for all derived-class instances.
Derived classes should check the type of other to preserve the symmetric nature of IEquatableDefinition.isSameDefinition(java.lang.Object).other - The other instance to compare to this one.true if the two objects are defined equivalently; otherwise false.protected int computeCurrentDefinitionHashCode()
MercuryCentralBody.checkForSameDefinition(agi.foundation.celestial.CentralBody) method.computeCurrentDefinitionHashCode in class CentralBodypublic void enumerateDependencies(DependencyEnumerator enumerator)
DependencyEnumerator#enumerate(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.enumerateDependencies in interface IEnumerateDependenciesenumerateDependencies in class DefinitionalObjectenumerator - The enumerator that is informed of the dependencies of this object.public String getName()
getName in class CentralBodypublic void setName(String value)
setName in class CentralBodyArgumentNullException - Thrown when value is null.public Point getCenterOfMassPoint()
getCenterOfMassPoint in class CentralBodypublic void setCenterOfMassPoint(Point value)
setCenterOfMassPoint in class CentralBodyArgumentNullException - Thrown when value is null.public ReferenceFrame getFixedFrame()
getFixedFrame in class CentralBodypublic void setFixedFrame(ReferenceFrame value)
setFixedFrame in class CentralBodyArgumentNullException - Thrown when value is null.public ReferenceFrame getInertialFrame()
getInertialFrame in class CentralBodypublic void setInertialFrame(ReferenceFrame value)
setInertialFrame in class CentralBodyArgumentNullException - Thrown when value is null.public ReferenceFrame getPrincipalFrame()
getPrincipalFrame in class CentralBodypublic void setPrincipalFrame(ReferenceFrame value)
setPrincipalFrame in class CentralBodyArgumentNullException - Thrown when value is null.public void synchronizeOrigins()
Origin (get / set) of the InertialFrame (get / set),
FixedFrame (get / set), and PrincipalFrame (get / set) to the
CenterOfMassPoint (get / set).synchronizeOrigins in class CentralBodypublic Ellipsoid getShape()
getShape in class CentralBodypublic void setShape(Ellipsoid value)
setShape in class CentralBodyArgumentNullException - Thrown when value is null.public final int getNaifIdCode()
Gets the NAIF identification code of this central body, barycenter, spacecraft, ground station, or other physical object or location.
A directory of NAIF IDs associated with commonly used Solar System bodies is available at the NAIF website.
This is equal to 1, which is actually the NAIF ID code for the Mercury System Barycenter. Because Mercury has no moons, the center of mass of Mercury is the same as its system barycenter.
getNaifIdCode in interface IProvideNaifIdCode