TimeCheckPointControllerLimitToCheckPoint Method |
Make sure next timestep does not go past next CheckPoint. Assume checkpoints are
sorted increasingly.
Namespace:
DHI.Mike1D.Generic
Assembly:
DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax public TimeSpan LimitToCheckPoint(
DateTime currentTime,
TimeSpan suggestedTimeStep
)
Public Function LimitToCheckPoint (
currentTime As DateTime,
suggestedTimeStep As TimeSpan
) As TimeSpan
public:
TimeSpan LimitToCheckPoint(
DateTime currentTime,
TimeSpan suggestedTimeStep
)
Parameters
- currentTime
- Type: SystemDateTime
[Missing <param name="currentTime"/> documentation for "M:DHI.Mike1D.Generic.TimeCheckPointController.LimitToCheckPoint(System.DateTime,System.TimeSpan)"]
- suggestedTimeStep
- Type: SystemTimeSpan
[Missing <param name="suggestedTimeStep"/> documentation for "M:DHI.Mike1D.Generic.TimeCheckPointController.LimitToCheckPoint(System.DateTime,System.TimeSpan)"]
Return Value
Type:
TimeSpan[Missing <returns> documentation for "M:DHI.Mike1D.Generic.TimeCheckPointController.LimitToCheckPoint(System.DateTime,System.TimeSpan)"]
See Also