StoppingConditionEvaluatorGetNextSampleSuggestion Method |
Gets the next step that the thing that is sampling this
StoppingConditionEvaluator
should take. The returned
Duration must be signed correctly. Override this method
if this particular stopping condition has some sense of how it should be sampled, or if it somehow
knows at what time it's extrema or thresholds will occur at.
Namespace:
AGI.Foundation.StoppingConditions
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public virtual Duration GetNextSampleSuggestion(
JulianDate lastNominalDateSampled,
Duration otherSuggestedStep,
ITimeBasedState state,
IntegrationSense direction
)
Public Overridable Function GetNextSampleSuggestion (
lastNominalDateSampled As JulianDate,
otherSuggestedStep As Duration,
state As ITimeBasedState,
direction As IntegrationSense
) As Duration
public:
virtual Duration GetNextSampleSuggestion(
JulianDate lastNominalDateSampled,
Duration otherSuggestedStep,
ITimeBasedState^ state,
IntegrationSense direction
)
abstract GetNextSampleSuggestion :
lastNominalDateSampled : JulianDate *
otherSuggestedStep : Duration *
state : ITimeBasedState *
direction : IntegrationSense -> Duration
override GetNextSampleSuggestion :
lastNominalDateSampled : JulianDate *
otherSuggestedStep : Duration *
state : ITimeBasedState *
direction : IntegrationSense -> Duration
Parameters
- lastNominalDateSampled
- Type: AGI.Foundation.TimeJulianDate
The last date that was sampled. - otherSuggestedStep
- Type: AGI.Foundation.TimeDuration
The current step that the propagator will take if
no other stopping condition will return a smaller value. This is returned in the base
implementation of this method. - state
- Type: AGI.Foundation.CoordinatesITimeBasedState
The state at the lastNominalDateSampled. - direction
- Type: AGI.Foundation.NumericalMethodsIntegrationSense
The integration direction.
Return Value
Type:
DurationThe correctly signed, smallest in magnitude, step that this stopping condition thinks it should take.
See Also