StoppablePropagatorCreateStoppedPropagatorResult Method |
Creates the results of the overall propagation after the stopping event has been found. This should be
overridden when your propagator stores additional data during propagation that should be returned. When
overriding this method, do not call the base implementation.
Namespace:
AGI.Foundation.Propagators
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.3.420.0 (24.3.420.0)
Syntax protected virtual StoppablePropagatorResults CreateStoppedPropagatorResult(
StoppingConditionEvent stoppingEvent,
IList<StoppingConditionEvent> detectedEvents,
IList<ITimeBasedState> savedStates,
bool aborted
)
Protected Overridable Function CreateStoppedPropagatorResult (
stoppingEvent As StoppingConditionEvent,
detectedEvents As IList(Of StoppingConditionEvent),
savedStates As IList(Of ITimeBasedState),
aborted As Boolean
) As StoppablePropagatorResults
protected:
virtual StoppablePropagatorResults^ CreateStoppedPropagatorResult(
StoppingConditionEvent^ stoppingEvent,
IList<StoppingConditionEvent^>^ detectedEvents,
IList<ITimeBasedState^>^ savedStates,
bool aborted
)
abstract CreateStoppedPropagatorResult :
stoppingEvent : StoppingConditionEvent *
detectedEvents : IList<StoppingConditionEvent> *
savedStates : IList<ITimeBasedState> *
aborted : bool -> StoppablePropagatorResults
override CreateStoppedPropagatorResult :
stoppingEvent : StoppingConditionEvent *
detectedEvents : IList<StoppingConditionEvent> *
savedStates : IList<ITimeBasedState> *
aborted : bool -> StoppablePropagatorResults
Parameters
- stoppingEvent
- Type: AGI.Foundation.StoppingConditionsStoppingConditionEvent
The event that actually stopped propagation. - detectedEvents
- Type: System.Collections.GenericIListStoppingConditionEvent
All of the events found during propagation. - savedStates
- Type: System.Collections.GenericIListITimeBasedState
All the states saved during propagation. - aborted
- Type: SystemBoolean
If the run was aborted.
Return Value
Type:
StoppablePropagatorResultsThe results for a propagation run.
See Also