agi.foundation.propagators

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

Class StoppablePropagatorResults

java.lang.Object

agi.foundation.propagators.StoppablePropagatorResults

Direct Known Subclasses:

SinglePointStoppablePropagatorResults, StoppableNumericalPropagatorResults

public class StoppablePropagatorResults
extends Object

The results of a StoppablePropagator. This type is designed to be extended with additional data computed during propagation.

Constructor Summary

Constructors

Constructor and Description
StoppablePropagatorResults(StoppingConditionEvent stoppingEvent, List<StoppingConditionEvent> detectedEvents, Iterable<? extends ITimeBasedState> propagatedStates, boolean aborted) Initializes a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	getAborted() Gets a value indicating whether the function run aborted.
StoppingCondition	getConditionStoppedOn() Gets the definition of the stopping condition that stopped the function.
List<StoppingConditionEvent>	getDetectedEvents() Gets all of the StoppingConditionEvents found during propagation.
StoppingConditionEvent	getEventThatStoppedPropagator() Gets the event that stopped the actual propagation.
JulianDate	getFinalDate() Gets the date at which propagation stopped.
ITimeBasedState	getFinalState() Gets the final state of propagation.
ArrayList<ITimeBasedState>	getPropagatedStates() Gets all of the states propagated.
double	getValueOfConditionThatStopped() Gets the value as computed by the stopping condition.

Methods inherited from class java.lang.Object

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

Constructor Detail

StoppablePropagatorResults

public StoppablePropagatorResults(StoppingConditionEvent stoppingEvent,
                                  List<StoppingConditionEvent> detectedEvents,
                                  Iterable<? extends ITimeBasedState> propagatedStates,
                                  boolean aborted)

Initializes a new instance.

Parameters:

detectedEvents - All the events detected by the propagator.

propagatedStates - The states computed and saved from the propagation.

stoppingEvent - The actual final event that stopped propagation. It is assumed that this is included in the detectedEvents.

aborted - A boolean indicated if the function run was aborted.

Method Detail

getDetectedEvents

public final List<StoppingConditionEvent> getDetectedEvents()

Gets all of the StoppingConditionEvents found during propagation.

getFinalDate

@Nonnull
public final JulianDate getFinalDate()

Gets the date at which propagation stopped.

getValueOfConditionThatStopped

public final double getValueOfConditionThatStopped()

Gets the value as computed by the stopping condition.

getConditionStoppedOn

public final StoppingCondition getConditionStoppedOn()

Gets the definition of the stopping condition that stopped the function.

getAborted

public final boolean getAborted()

Gets a value indicating whether the function run aborted.

getFinalState

public final ITimeBasedState getFinalState()

Gets the final state of propagation.

getPropagatedStates

public final ArrayList<ITimeBasedState> getPropagatedStates()

Gets all of the states propagated.

getEventThatStoppedPropagator

public final StoppingConditionEvent getEventThatStoppedPropagator()

Gets the event that stopped the actual propagation.