agi.foundation.propagators

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

Interface IUpdatePriorToStep

All Superinterfaces:

AutoCloseable, IAvailability, ICloneWithContext, IDisposable, IEvaluator, IThreadAware

public interface IUpdatePriorToStep
extends IEvaluator

An interface to an object created by a PropagationStateElement that has special behavior that takes place each time step prior to propagation. The NumericalPropagator will call the IUpdatePriorToStep.updatePriorToStep(agi.foundation.time.JulianDate, agi.foundation.propagators.PropagationStateArray) method in this class to perform that behavior.

Method Summary

Modifier and Type	Method and Description
void	updatePriorToStep(JulianDate date, PropagationStateArray state) Called by the NumericalPropagator each time step prior to propagation to perform any state updates required by the PropagationStateElement that created this object.

Methods inherited from interface agi.foundation.IEvaluator

getCachingWrapper, getGroup, updateEvaluatorReferences

Methods inherited from interface agi.foundation.time.IAvailability

getAvailabilityIntervals, isAvailable

Methods inherited from interface agi.foundation.infrastructure.IThreadAware

getIsThreadSafe

Methods inherited from interface agi.foundation.infrastructure.ICloneWithContext

clone

Methods inherited from interface agi.foundation.compatibility.IDisposable

close, dispose

Method Detail

updatePriorToStep

void updatePriorToStep(@Nonnull
                       JulianDate date,
                       @Nonnull
                       PropagationStateArray state)

Called by the NumericalPropagator each time step prior to propagation to perform any state updates required by the PropagationStateElement that created this object.

Parameters:

date - The time of the current step.

state - The subsection of the state array needed by this object.