agi.foundation.coordinates

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

Class NumericalPropagatorAdapterHelper

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.coordinates.NumericalPropagatorAdapterHelper

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public final class NumericalPropagatorAdapterHelper
extends DefinitionalObject

Contains various helper methods and properties will make using NumericalPropagatorDefinition and StateElementAdapters easier. When constructing adapters that involve a NumericalPropagator, initialize a new instance of this in every constructor (or update the reference of the existing one in the copy constructor).

Constructor Summary

Constructors

Constructor and Description
NumericalPropagatorAdapterHelper() Initializes a new 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.
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.
StateElementAdapterDefinition	getAdapter(String elementIdentification) Gets the adapter for the specified elementIdentification.
static Map<Class<?>,CreateAdapterCallback>	getAdaptersForAllNumericalPropagatedSegments() Gets the default list of all of the possible state element adapters.
Object	getDefinedIn(String elementIdentification) Gets the defined in object for the specified element, or null if there is none.
List<String>	getElements() Gets all of the elements in the PropagatorDefinition (get / set) which should also be all of the elements getting propagated.
NumericalPropagatorDefinition	getPropagatorDefinition() Gets the NumericalPropagatorDefinition that will be used for the segment.
void	setPropagatorDefinition(NumericalPropagatorDefinition value) Sets the NumericalPropagatorDefinition that will be used for the segment.

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

Constructor Detail

NumericalPropagatorAdapterHelper

public NumericalPropagatorAdapterHelper()

Initializes a new instance.

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 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.

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 NumericalPropagatorAdapterHelper.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.

getAdaptersForAllNumericalPropagatedSegments

public static Map<Class<?>,CreateAdapterCallback> getAdaptersForAllNumericalPropagatedSegments()

Gets the default list of all of the possible state element adapters. If you are propagating your own elements in a state and have made your own custom adapters, you can add those factories to this list so all of the segments that leverage this helper type will have the needed adapters.

getElements

@Nonnull
public final List<String> getElements()

Gets all of the elements in the PropagatorDefinition (get / set) which should also be all of the elements getting propagated.

getAdapter

public final StateElementAdapterDefinition getAdapter(String elementIdentification)

Gets the adapter for the specified elementIdentification.

Parameters:

elementIdentification - The name of the propagation or auxiliary element whose adapter is desired.

Returns:

The uninitialized StateElementAdapter for the specified elementIdentification.

getPropagatorDefinition

public final NumericalPropagatorDefinition getPropagatorDefinition()

Gets the NumericalPropagatorDefinition that will be used for the segment.

setPropagatorDefinition

public final void setPropagatorDefinition(NumericalPropagatorDefinition value)

Sets the NumericalPropagatorDefinition that will be used for the segment.

getDefinedIn

public final Object getDefinedIn(String elementIdentification)

Gets the defined in object for the specified element, or null if there is none.

Parameters:

elementIdentification - The elements identification.

Returns:

The defined-in object for the specified element, often a ReferenceFrame or Axes