SimulationTimer Class

Generates an event at regular intervals of a simulation.

This class will trigger events either at every timestep, or at regular intervals.

To trigger events at regular timestep frequency, set the Frequency to a positive value.

To trigger events at regular intervals, set the Frequency to zero, and the Interval to a positive value.

Definition

Namespace: DHI.Mike1D.Generic
Assembly: DHI.Mike1D.Generic (in DHI.Mike1D.Generic.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class SimulationTimer
Inheritance
Object    SimulationTimer

Constructors

SimulationTimerInitializes a new instance of the SimulationTimer class

Properties

EndTime End time of when to trigger events. Times after this will not trigger any events
Frequency Frequency of events from time steps. Setting this will trigger an event at this frequency of the time step. Setting to zero will disable the frequency triggering, and instead use the interval triggering.
Interval Interval between events. Only applicable when Frequency is disabled, i.e. set to zero.
StartTime Start time of when to trigger events. First event that can be triggered is at exactly StartTime
TriggerCount Number of times the event has been triggered.
UpdateCount Number of times the update method had been called, within StartTime and EndTime

Methods

EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Reset Reset timer for new simulation.
Rewind Rewind timer to a previous time
TimeUpdate To be called every time a time step has completed successfully
ToStringReturns a string that represents the current object.
(Inherited from Object)

Events

Elapsed Event that is triggered when the interval elapses.

See Also