agi.foundation.propagators.advanced

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

Class PropagationPointElement

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.propagators.advanced.PropagationStateElement

agi.foundation.propagators.advanced.PropagationPointElement

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

Direct Known Subclasses:

PropagationNewtonianPoint

public abstract class PropagationPointElement
extends PropagationStateElement

A PropagationStateElement describing an integrated point.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected abstract boolean	checkForSameDefinition(PropagationPointElement other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(PropagationStateElement 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.
abstract ReferenceFrame	getIntegrationFrame() Gets the frame of the integrated point.
abstract Point	getIntegrationPoint() Gets the Point of the integrated position.
abstract void	setIntegrationFrame(ReferenceFrame value) Sets the frame of the integrated point.

Methods inherited from class agi.foundation.propagators.advanced.PropagationStateElement

checkForSameDefinition, getConverter, getDerivatives, getDimension, getIdentification, getIncludeHighestDerivativeInOutput, getOrder, getStateParameter, getStateUpdater, setIdentification, setIncludeHighestDerivativeInOutput, setStateParameter

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, areSameDefinition, clone, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, collectionItemsAreSameDefinition, dictionaryItemsAreSameDefinition, enumerateDependencies, 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

Constructor Detail

PropagationPointElement

protected PropagationPointElement()

Initializes a new instance.

PropagationPointElement

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

Parameters:

other - The other instance to compare to this one.

Returns:

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

checkForSameDefinition

protected abstract boolean checkForSameDefinition(PropagationPointElement 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 PropagationPointElement.checkForSameDefinition(agi.foundation.propagators.advanced.PropagationStateElement) method.

Overrides:

computeCurrentDefinitionHashCode in class PropagationStateElement

Returns:

The computed hash code.

getIntegrationPoint

public abstract Point getIntegrationPoint()

Gets the Point of the integrated position.

getIntegrationFrame

public abstract ReferenceFrame getIntegrationFrame()

Gets the frame of the integrated point.

setIntegrationFrame

public abstract void setIntegrationFrame(ReferenceFrame value)

Sets the frame of the integrated point.