agi.foundation.celestial

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

Class PlanetarySystemBarycenter

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.celestial.PlanetarySystemBarycenter

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable, IThreadAware

Direct Known Subclasses:

EarthMoonBarycenter, JupiterSystemBarycenter, MarsSystemBarycenter, NeptuneSystemBarycenter, PlutoSystemBarycenter, SaturnSystemBarycenter, UranusSystemBarycenter

public abstract class PlanetarySystemBarycenter
extends DefinitionalObject
implements IThreadAware

The barycenter of a planetary system. Used to define the orbits of planetary satellites.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PlanetarySystemBarycenter() Initializes a new instance.
protected	PlanetarySystemBarycenter(PlanetarySystemBarycenter 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(DefinitionalObject other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(PlanetarySystemBarycenter other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
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 planetary system.
ReferenceFrame	getInertialFrame() Gets the default inertial frame for this planetary system.
abstract boolean	getIsThreadSafe() Gets a value indicating whether the methods on this instance are safe to call from multiple threads simultaneously.
String	getName() Gets the name of this planetary system's barycenter.
void	setCenterOfMassPoint(Point value) Sets a point describing the center of mass of this planetary system.
void	setInertialFrame(ReferenceFrame value) Sets the default inertial frame for this planetary system.
void	setName(String value) Sets the name of this planetary system's barycenter.
void	synchronizeOrigins() Sets the Origin (get / set) of the InertialFrame (get / set) to the CenterOfMassPoint (get / set).

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, 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

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Constructor Detail

PlanetarySystemBarycenter

protected PlanetarySystemBarycenter()

Initializes a new instance.

PlanetarySystemBarycenter

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

checkForSameDefinition

protected final boolean checkForSameDefinition(DefinitionalObject 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 DefinitionalObject

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(@Nullable
                                         PlanetarySystemBarycenter 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 PlanetarySystemBarycenter.checkForSameDefinition(agi.foundation.infrastructure.DefinitionalObject) method.

Overrides:

computeCurrentDefinitionHashCode in class DefinitionalObject

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.

getIsThreadSafe

public abstract 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

getName

@Nullable
public final String getName()

Gets the name of this planetary system's barycenter.

setName

public final void setName(@Nullable
                          String value)

Sets the name of this planetary system's barycenter.

Throws:

ArgumentNullException - Thrown when value is null.

getCenterOfMassPoint

@Nonnull
public final Point getCenterOfMassPoint()

Gets a point describing the center of mass of this planetary system.

setCenterOfMassPoint

public final void setCenterOfMassPoint(@Nonnull
                                       Point value)

Sets a point describing the center of mass of this planetary system.

Throws:

ArgumentNullException - Thrown when value is null.

getInertialFrame

@Nullable
public final ReferenceFrame getInertialFrame()

Gets the default inertial frame for this planetary system.

setInertialFrame

public final void setInertialFrame(@Nullable
                                   ReferenceFrame value)

Sets the default inertial frame for this planetary system.

Throws:

ArgumentNullException - Thrown when value is null.

synchronizeOrigins

public final void synchronizeOrigins()

Sets the Origin (get / set) of the InertialFrame (get / set) to the CenterOfMassPoint (get / set).