Apv Class |
Class for handling APV files, especially the _spi_ file and _kill_ files
Inheritance HierarchyNamespace: DHI.Mike1D.SimLauncher
Assembly: DHI.Mike1D.SimLauncher (in DHI.Mike1D.SimLauncher.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe Apv type exposes the following members.
ConstructorsProperties| Name | Description | |
|---|---|---|
 | SimRunning |
Set to true when simulation is running
|
| ToConsole |
Set to true to get output to console
|
Methods| Name | Description | |
|---|---|---|
 | CancelSimulation |
Returns true if the simulation should be cancelled.
|
| Custom |
Custom text to APV file.
|
| 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.) |
| Finish |
Finish APV system
|
| GetHashCode | Serves as the default hash function. (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.) |
| Message |
Message - usually time step counter, '5 of 1000' or similar.
Also used to say: 'Initialize' etc.
|
| Progress(Double) |
Report the simulation progress.
|
| Progress(Int32) | Obsolete.
Report the simulation progress in per-mille.
|
| SetMessageLabel |
Label to show in message field (at mouse-over)
|
| SetStatusLabel |
Label to show in status field (at mouse-over)
|
| Signal |
Signal is a way to report events through the
APV system. Signal string should not be localized.
|
| Speed |
Set speed of simulation
|
| Start |
Start APV system
|
| Status |
Status - usually simulation date/time
|
| TimeLeft |
Report the time left before simulation end
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also