StoppablePropagatorTakeStep Method |
Makes the propagator take a step. You do not need to update any other properties on the
base type in the overridden method. Note that the sign of the step matters, if
is it negative then the step should be taken backwards.
Namespace:
AGI.Foundation.Propagators
Assembly:
AGI.Foundation.Models (in AGI.Foundation.Models.dll) Version: 24.2.419.0 (24.2.419.0)
Syntax public abstract ITimeBasedState TakeStep(
Duration step,
bool createNewState
)
Public MustOverride Function TakeStep (
step As Duration,
createNewState As Boolean
) As ITimeBasedState
public:
virtual ITimeBasedState^ TakeStep(
Duration step,
bool createNewState
) abstract
abstract TakeStep :
step : Duration *
createNewState : bool -> ITimeBasedState
Parameters
- step
- Type: AGI.Foundation.TimeDuration
The step to take from the CurrentDate. You do not need to
update the CurrentDate or any other properties on the base type in the overridden
method. - createNewState
- Type: SystemBoolean
For performance reasons, it is not always desirable to create a
new ITimeBasedState at every step. If this is true, you must create a
new instance of a state. If this is false, then this method can return a mutable state
that has just been updated with the current information.
Return Value
Type:
ITimeBasedStateThe state at the
CurrentDate plus the
step.
See Also