agi.foundation.propagators

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

Class DynamicStateStoppablePropagator

java.lang.Object

agi.foundation.infrastructure.DefinitionalObject

agi.foundation.propagators.StoppablePropagatorDefinition

agi.foundation.propagators.DynamicStateStoppablePropagator

All Implemented Interfaces:

ICloneWithContext, IEnumerateDependencies, IEquatableDefinition, IFreezable

public class DynamicStateStoppablePropagator
extends StoppablePropagatorDefinition

A StoppablePropagator that evaluates a StateEvaluator in time until a StoppingCondition is tripped. The initial state of this segment will only be used to evaluate the DynamicState (get / set) at the date of the passed in state. The DynamicState (get / set) does not have a way to initialize the values within it, so except for the date this propagator can not be initialized with an initial state at propagation time. As such this propagator does not need adapters.

Constructor Summary

Constructors

Modifier	Constructor and Description
	DynamicStateStoppablePropagator() Initializes a new instance.
protected	DynamicStateStoppablePropagator(DynamicStateStoppablePropagator 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(DynamicStateStoppablePropagator other) Checks to determine if another instance has the same definition as this instance and returns true if it does.
protected boolean	checkForSameDefinition(StoppablePropagatorDefinition 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.
protected void	freezeAggregatedObjects() Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object.
boolean	getAutomaticallyAddEndOfAvailabilityStoppingConditions() Gets a value indicating whether the propagator should automatically have a pair of StoppingConditions that will stop propagation at the start or end times of this propagators availability.
DynamicState<IAdjustableState>	getDynamicState() Gets the definition of the StateEvaluator that will be propagated.
JulianDate	getInitialDate() Gets the initial date to propagate from.
Duration	getStep() Gets the default step-size that this propagator should take.
StoppablePropagator	getStoppablePropagator(EvaluatorGroup group, List<StateElementAdapterDefinition> previousAdapters) Creates and initialize the actual StoppablePropagator.
void	setAutomaticallyAddEndOfAvailabilityStoppingConditions(boolean value) Sets a value indicating whether the propagator should automatically have a pair of StoppingConditions that will stop propagation at the start or end times of this propagators availability.
void	setDynamicState(DynamicState<IAdjustableState> value) Sets the definition of the StateEvaluator that will be propagated.
void	setInitialDate(JulianDate value) Sets the initial date to propagate from.
void	setStep(Duration value) Sets the default step-size that this propagator should take.

Methods inherited from class agi.foundation.propagators.StoppablePropagatorDefinition

addAnyConditionSatisfied, checkForSameDefinition, containsAdapter, getAdapter, getAllAdapters, getDirection, getStoppablePropagator, getStoppablePropagator, getStoppingConditions, getTimeTolerance, onAnyConditionSatisfied, removeAdapter, removeAnyConditionSatisfied, setAdapter, setTimeTolerance

Methods inherited from class agi.foundation.infrastructure.DefinitionalObject

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

DynamicStateStoppablePropagator

public DynamicStateStoppablePropagator()

Initializes a new instance.

DynamicStateStoppablePropagator

protected DynamicStateStoppablePropagator(@Nonnull
                                          DynamicStateStoppablePropagator 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(StoppablePropagatorDefinition 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).

Overrides:

checkForSameDefinition in class StoppablePropagatorDefinition

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(DynamicStateStoppablePropagator 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 DynamicStateStoppablePropagator.checkForSameDefinition(agi.foundation.propagators.StoppablePropagatorDefinition) method.

Overrides:

computeCurrentDefinitionHashCode in class StoppablePropagatorDefinition

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 StoppablePropagatorDefinition

Parameters:

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

freezeAggregatedObjects

protected void freezeAggregatedObjects()

Called by DefinitionalObject.freeze() to also freeze any objects that are considered to be a part of this object. Derived classes which contain additional aggregated objects MUST override this method, call the base implementation, and freeze aggregated objects introduced by the derived class. The objects that need to be frozen in this method are frequently created in this object's constructor and are not settable via properties.

Overrides:

freezeAggregatedObjects in class StoppablePropagatorDefinition

getStoppablePropagator

public StoppablePropagator getStoppablePropagator(EvaluatorGroup group,
                                                  List<StateElementAdapterDefinition> previousAdapters)

Creates and initialize the actual StoppablePropagator.

Specified by:

getStoppablePropagator in class StoppablePropagatorDefinition

Parameters:

group - The group to use to initialize any evaluators that will be used.

previousAdapters - The previous adapters to use to configure this propagators adapters.

Returns:

The propagator for this StoppablePropagatorDefinition.

getStep

@Nonnull
public final Duration getStep()

Gets the default step-size that this propagator should take.

setStep

public final void setStep(@Nonnull
                          Duration value)

Sets the default step-size that this propagator should take.

getDynamicState

public final DynamicState<IAdjustableState> getDynamicState()

Gets the definition of the StateEvaluator that will be propagated.

setDynamicState

public final void setDynamicState(DynamicState<IAdjustableState> value)

Sets the definition of the StateEvaluator that will be propagated.

getAutomaticallyAddEndOfAvailabilityStoppingConditions

public final boolean getAutomaticallyAddEndOfAvailabilityStoppingConditions()

Gets a value indicating whether the propagator should automatically have a pair of StoppingConditions that will stop propagation at the start or end times of this propagators availability. By default this is true and should only be set to false if calling code is sure that propagation will never go beyond the availability.

setAutomaticallyAddEndOfAvailabilityStoppingConditions

public final void setAutomaticallyAddEndOfAvailabilityStoppingConditions(boolean value)

Sets a value indicating whether the propagator should automatically have a pair of StoppingConditions that will stop propagation at the start or end times of this propagators availability. By default this is true and should only be set to false if calling code is sure that propagation will never go beyond the availability.

getInitialDate

@Nonnull
public final JulianDate getInitialDate()

Gets the initial date to propagate from.

setInitialDate

public final void setInitialDate(@Nonnull
                                 JulianDate value)

Sets the initial date to propagate from.