agi.foundation.propagators

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

Class PropagationEventArgs

java.lang.Object

agi.foundation.compatibility.EventArgs

agi.foundation.propagators.PropagationEventArgs

public class PropagationEventArgs
extends EventArgs

Provides information about the current propagation event conditions and provides a means of indicating how the propagation should continue.

Field Summary

Fields inherited from class agi.foundation.compatibility.EventArgs

Empty

Constructor Summary

Constructors

Constructor and Description
PropagationEventArgs(JulianDate previousTime, double[] previousState, JulianDate currentDate, double[] currentState, PropagationEventTrigger trigger, StepSizeInformation info) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
double[]	getCurrentState() Gets the raw state at the end of the current step when this event is fired.
JulianDate	getCurrentTime() Gets the time at the end of the current step when this event is fired.
PropagationEventIndication	getIndication() Gets an indication of how the propagator should continue after this event.
double[]	getPreviousState() Gets the raw state at the beginning of the current step.
JulianDate	getPreviousTime() Gets the time at the beginning of the current step.
StepSizeInformation	getStepSizeInformation() Gets information about the last step taken by the integrator.
PropagationEventTrigger	getTrigger() Gets information about which method triggered this event.
void	setIndication(PropagationEventIndication value) Sets an indication of how the propagator should continue after this event.
void	stopPropagation() Sets the Indication (get / set) to PropagationEventIndication.STOP_PROPAGATION_AFTER_STEP to prevent further propagation after this step.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PropagationEventArgs

public PropagationEventArgs(@Nonnull
                            JulianDate previousTime,
                            double[] previousState,
                            @Nonnull
                            JulianDate currentDate,
                            double[] currentState,
                            @Nonnull
                            PropagationEventTrigger trigger,
                            @Nonnull
                            StepSizeInformation info)

Initializes a new instance.

Parameters:

previousTime - The time at the beginning of the current step.

previousState - The raw state at the beginning of the current step.

currentDate - The time at the end of the current step when the event is fired.

currentState - The raw state at the end of the current step when the event is fired.

trigger - Indication of which method triggered this event.

info - Information about the last step taken by the integrator.

Method Detail

getPreviousTime

@Nonnull
public final JulianDate getPreviousTime()

Gets the time at the beginning of the current step.

getPreviousState

public final double[] getPreviousState()

Gets the raw state at the beginning of the current step.

getCurrentTime

@Nonnull
public final JulianDate getCurrentTime()

Gets the time at the end of the current step when this event is fired.

getCurrentState

public final double[] getCurrentState()

Gets the raw state at the end of the current step when this event is fired.

getStepSizeInformation

@Nonnull
public final StepSizeInformation getStepSizeInformation()

Gets information about the last step taken by the integrator.

getTrigger

@Nonnull
public final PropagationEventTrigger getTrigger()

Gets information about which method triggered this event.

getIndication

@Nonnull
public final PropagationEventIndication getIndication()

Gets an indication of how the propagator should continue after this event. By default, the propagation will continue, unless the event handler indicates a different condition.

setIndication

public final void setIndication(@Nonnull
                                PropagationEventIndication value)

Sets an indication of how the propagator should continue after this event. By default, the propagation will continue, unless the event handler indicates a different condition.

stopPropagation

public final void stopPropagation()

Sets the Indication (get / set) to PropagationEventIndication.STOP_PROPAGATION_AFTER_STEP to prevent further propagation after this step. To continue propagation after stopping it, call NumericalPropagator.propagate(Duration) again or take steps manually by calling NumericalPropagator.takeStep() or NumericalPropagator.restep(double).