agi.foundation.celestial

Class ThirdBodyGravity.ThirdBodyInfo

java.lang.Object

agi.foundation.celestial.ThirdBodyGravity.ThirdBodyInfo

All Implemented Interfaces:

IEquatable<ThirdBodyGravity.ThirdBodyInfo>

Enclosing class:

ThirdBodyGravity

public static class ThirdBodyGravity.ThirdBodyInfo
extends Object
implements IEquatable<ThirdBodyGravity.ThirdBodyInfo>

A combination of the position and gravitational parameter for a perturbing gravitational body.

Constructor Summary

Constructors

Constructor and Description
ThirdBodyInfo(String name, Point position, double gravitationalParameter) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Returns true if this object is equivalent to the given object.
static boolean	equals(ThirdBodyGravity.ThirdBodyInfo left, ThirdBodyGravity.ThirdBodyInfo right) Returns true if the two instances are exactly equal.
boolean	equalsType(ThirdBodyGravity.ThirdBodyInfo other) Indicates whether another instance of this type is exactly equal to this instance.
double	getGravitationalParameter() Gets the gravitational parameter of the perturbing gravitational body, in meters cubed per second squared.
String	getName() Gets the string identifying the name of the perturbing gravitational body.
Point	getPosition() Gets the Point representing the position of the perturbing gravitational body.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(ThirdBodyGravity.ThirdBodyInfo left, ThirdBodyGravity.ThirdBodyInfo right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThirdBodyInfo

public ThirdBodyInfo(@Nonnull
                     String name,
                     @Nonnull
                     Point position,
                     double gravitationalParameter)

Initializes a new instance.

Parameters:

name - The name to identify the perturbing gravitational body.

position - The position of the perturbing gravitational body.

gravitationalParameter - The gravitational parameter of the body, in meters cubed per second squared.

Method Detail

getName

@Nonnull
public final String getName()

Gets the string identifying the name of the perturbing gravitational body.

getPosition

@Nonnull
public final Point getPosition()

Gets the Point representing the position of the perturbing gravitational body.

getGravitationalParameter

public final double getGravitationalParameter()

Gets the gravitational parameter of the perturbing gravitational body, in meters cubed per second squared.

equals

public boolean equals(Object obj)

Returns true if this object is equivalent to the given object.

Overrides:

equals in class Object

Parameters:

obj - The object to test.

Returns:

True if the given object is equivalent to this object.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(ThirdBodyGravity.ThirdBodyInfo other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<ThirdBodyGravity.ThirdBodyInfo>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public static boolean equals(ThirdBodyGravity.ThirdBodyInfo left,
                             ThirdBodyGravity.ThirdBodyInfo right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(ThirdBodyGravity.ThirdBodyInfo left,
                                ThirdBodyGravity.ThirdBodyInfo right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)