StoppablePropagatorPropagateUntilStop Method (ITimeBasedState, IntegrationSense, ITrackCalculationProgress) |
Namespace:
AGI.Foundation.Propagators
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public StoppablePropagatorResults PropagateUntilStop(
ITimeBasedState initialState,
IntegrationSense direction,
ITrackCalculationProgress progressTracker
)
Public Function PropagateUntilStop (
initialState As ITimeBasedState,
direction As IntegrationSense,
progressTracker As ITrackCalculationProgress
) As StoppablePropagatorResults
public:
StoppablePropagatorResults^ PropagateUntilStop(
ITimeBasedState^ initialState,
IntegrationSense direction,
ITrackCalculationProgress^ progressTracker
)
member PropagateUntilStop :
initialState : ITimeBasedState *
direction : IntegrationSense *
progressTracker : ITrackCalculationProgress -> StoppablePropagatorResults
Parameters
- initialState
- Type: AGI.Foundation.CoordinatesITimeBasedState
The initial state to begin propagating from. - direction
- Type: AGI.Foundation.NumericalMethodsIntegrationSense
The direction to search for an event. - progressTracker
- Type: AGI.FoundationITrackCalculationProgress
An optional progress tracker.
How long the segment will take to propagate generally is not known ahead of time, so the reported
progress completed is set to -1. But you can cancel propagation with the tracker.
Return Value
Type:
StoppablePropagatorResultsThe ephemeris and information about the stopping event.
See Also