LTSEventList Class |
List of LTS events. An event is a set of values with a time stamp. This class is abstract, and
the calculation of the values in the events is performed in the purely abstract function Update().
Inheritance HierarchySystemObject
DHI.Mike1D.Mike1DDataAccessLTSEventList
DHI.Mike1D.Mike1DDataAccessLTSEventListAnnualIntegrated
DHI.Mike1D.Mike1DDataAccessLTSEventListDuration
DHI.Mike1D.Mike1DDataAccessLTSEventListIntegrated
DHI.Mike1D.Mike1DDataAccessLTSEventListMax
DHI.Mike1D.Mike1DDataAccessLTSEventListTotalIntegratedDischargeOut
DHI.Mike1D.Mike1DDataAccessLTSEventList
DHI.Mike1D.Mike1DDataAccessLTSEventListAnnualIntegrated
DHI.Mike1D.Mike1DDataAccessLTSEventListDuration
DHI.Mike1D.Mike1DDataAccessLTSEventListIntegrated
DHI.Mike1D.Mike1DDataAccessLTSEventListMax
DHI.Mike1D.Mike1DDataAccessLTSEventListTotalIntegratedDischargeOut
Namespace: DHI.Mike1D.Mike1DDataAccess
Assembly: DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 16.0.0.0 (11.1.1.1111)
SyntaxC#
public abstract class LTSEventList
The LTSEventList type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LTSEventList |
Constructor
|
Properties| Name | Description | |
|---|---|---|
 | Getter |
The current value to use when calculating the maximum
|
| MaxNumberOfResults |
The maximum number of result that will be written to the result file.
|
| MinimumTimeBetweenValues |
Two events in the event list should be separated by at least this TimeSpan. If they are closer
together then they are considered part of the same event.
|
Methods| Name | Description | |
|---|---|---|
 | Add(DateTime, Double) |
Add an event with a single value to the list
|
| Add(DateTime, Double, Double) |
Add an event with two values to the list
|
| Add(DateTime, Double, Double, Double) |
Add an event with three values to the list
|
| CommitLastValueInJob |
Commit the last value in the LTS job (and LTS simulation consists of multiple jobs)
|
| CommitLastValueInSimulation |
Commit the last value in the LTS simulation (and LTS simulation consists of multiple jobs)
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PrepareForNextLTSJob |
Resets the state of the eventlist in preparation for another simulation in the LTS sequence.
|
| SortOnTime |
Sort the event list on time stamps
|
| SortOnValue1 |
Sort the event list on the first value of each event
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Update |
Update calculates the values in the events.
|
| WriteToPFSFile |
Write this event list to a PFS file (MU ERF format)
|
Fields| Name | Description | |
|---|---|---|
 | _events | List of LTS events |
| _getter |
The current value to use when calculating the maximum
|
| _minimumTimeBetweenValues |
Two events in the event list should be separated by at least this TimeSpan. If they are closer
together then they are considered part of the same event.
|
| _zeroFlow | Zero flow tolerance |
See Also