agi.foundation.celestial

(agi.foundation.models-2024r1.jar)

Class NeptuneCentralBody

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.CentralBody

agi.foundation.celestial.NeptuneCentralBody

All Implemented Interfaces:

IKinematicStateService, ILocationPointService, IOrientationAxesService, ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IThreadAware, IServiceProvider, IProvideNaifIdCode

public class NeptuneCentralBody
extends CentralBody
implements IProvideNaifIdCode

The planet Neptune. You should generally obtain an instance of this class from the CentralBodiesFacet instance in the calculation context instead of creating one directly.

See NeptuneCentralBody.NeptuneCentralBody() for a description of the default instance of this class that is found in the CalculationContext.

Field Summary

Fields

Modifier and Type	Field and Description
static double	Iau2006NeptuneMajorAxis Shape values are from "Report of the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements: 2006", Celestial Mechanics Dyn Astry 98: 155-180, 2007.
static double	Iau2006NeptuneMinorAxis Shape values are from "Report of the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements: 2006", Celestial Mechanics Dyn Astry 98: 155-180, 2007.

Constructor Summary

Constructors

Modifier	Constructor and Description
	NeptuneCentralBody() Initializes a new instance.
protected	NeptuneCentralBody(NeptuneCentralBody existingInstance, CopyContext context) Initializes a new instance as a copy of an existing instance.

Method Summary

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(NeptuneCentralBody 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() Sets the Origin (get / set) of the InertialFrame (get / set), FixedFrame (get / set), and PrincipalFrame (get / set) to the CenterOfMassPoint (get / set).

Methods inherited from class agi.foundation.celestial.CentralBody

checkForSameDefinition, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getAzimuthElevationRangeEvaluator, getIsThreadSafe, getLocationPoint, getOrientationAxes, getReferenceFrame, getService, observeCartographicPoint, observeCartographicPoint

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, freeze, freezeAggregatedObjects, getCollectionHashCode, getCollectionHashCode, getCollectionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDefinitionHashCode, getDictionaryHashCode, getIsFrozen, isSameDefinition, throwIfFrozen

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Iau2006NeptuneMajorAxis

public static final double Iau2006NeptuneMajorAxis

Shape values are from "Report of the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements: 2006", Celestial Mechanics Dyn Astry 98: 155-180, 2007.

See Also:

Constant Field Values

Iau2006NeptuneMinorAxis

public static final double Iau2006NeptuneMinorAxis

Shape values are from "Report of the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements: 2006", Celestial Mechanics Dyn Astry 98: 155-180, 2007.

See Also:

Constant Field Values

Constructor Detail

NeptuneCentralBody

public NeptuneCentralBody()

Initializes a new instance.

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 NeptuneCentralBody has the following characteristics:

• The CenterOfMassPoint (get / set) is defined by Neptune (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.
• The Shape (get / set) is an oblate spheroid by default that uses NeptuneCentralBody.Iau2006NeptuneMajorAxis as the equatorial radius and NeptuneCentralBody.Iau2006NeptuneMinorAxis as the polar radius.
• The InertialFrame (get / set) uses the CentralBodyInertialAxes with the Iau2015Orientation.computeNeptune(agi.foundation.time.JulianDate) orientation function.
• Both the FixedFrame (get / set) and PrincipalFrame (get / set) use the IAU/IAG working group 2015 report. See Iau2015Orientation for additional details on this orientation information.

NeptuneCentralBody

protected NeptuneCentralBody(@Nonnull
                             NeptuneCentralBody 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 DefinitionalObject

Parameters:

context - The context to use to perform the copy.

Returns:

A new instance which is a copy of this object.

checkForSameDefinition

protected final boolean checkForSameDefinition(CentralBody other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Specified by:

checkForSameDefinition in class CentralBody

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

checkForSameDefinition

protected boolean checkForSameDefinition(NeptuneCentralBody other)

Checks to determine if another instance has the same definition as this instance and returns 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).

Parameters:

other - The other instance to compare to this one.

Returns:

true if the two objects are defined equivalently; otherwise false.

computeCurrentDefinitionHashCode

protected int computeCurrentDefinitionHashCode()

Computes a hash code based on the current properties of this object. Derived classes MUST override this method and compute a hash code that combines: a unique hash code seed, the base implementation result, and the hash codes of all new fields introduced by the derived class which are used in the NeptuneCentralBody.checkForSameDefinition(agi.foundation.celestial.CentralBody) method.

Overrides:

computeCurrentDefinitionHashCode in class CentralBody

Returns:

The computed hash code.

enumerateDependencies

public void enumerateDependencies(DependencyEnumerator enumerator)

Enumerates the dependencies of this object by calling 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.

Specified by:

enumerateDependencies in interface IEnumerateDependencies

Overrides:

enumerateDependencies in class DefinitionalObject

Parameters:

enumerator - The enumerator that is informed of the dependencies of this object.

getName

public String getName()

Gets the name of the central body.

Specified by:

getName in class CentralBody

setName

public void setName(String value)

Sets the name of the central body.

Specified by:

setName in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getCenterOfMassPoint

public Point getCenterOfMassPoint()

Gets a point describing the center of mass of this central body.

Specified by:

getCenterOfMassPoint in class CentralBody

setCenterOfMassPoint

public void setCenterOfMassPoint(Point value)

Sets a point describing the center of mass of this central body.

Specified by:

setCenterOfMassPoint in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getFixedFrame

public ReferenceFrame getFixedFrame()

Gets the default Fixed frame that corresponds to the surface features of this central body.

Specified by:

getFixedFrame in class CentralBody

setFixedFrame

public void setFixedFrame(ReferenceFrame value)

Sets the default Fixed frame that corresponds to the surface features of this central body.

Specified by:

setFixedFrame in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getInertialFrame

public ReferenceFrame getInertialFrame()

Gets the default Inertial frame for this central body.

Specified by:

getInertialFrame in class CentralBody

setInertialFrame

public void setInertialFrame(ReferenceFrame value)

Sets the default Inertial frame for this central body.

Specified by:

setInertialFrame in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getPrincipalFrame

public ReferenceFrame getPrincipalFrame()

Gets the default Fixed frame that corresponds to the gravity frame of this central body.

Specified by:

getPrincipalFrame in class CentralBody

setPrincipalFrame

public void setPrincipalFrame(ReferenceFrame value)

Sets the default Fixed frame that corresponds to the gravity frame of this central body.

Specified by:

setPrincipalFrame in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

synchronizeOrigins

public void synchronizeOrigins()

Sets the Origin (get / set) of the InertialFrame (get / set), FixedFrame (get / set), and PrincipalFrame (get / set) to the CenterOfMassPoint (get / set).

Specified by:

synchronizeOrigins in class CentralBody

getShape

public Ellipsoid getShape()

Gets the shape of this central body.

Specified by:

getShape in class CentralBody

setShape

public void setShape(Ellipsoid value)

Sets the shape of this central body.

Specified by:

setShape in class CentralBody

Throws:

ArgumentNullException - Thrown when value is null.

getNaifIdCode

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.

Specified by:

getNaifIdCode in interface IProvideNaifIdCode