Apv Class

Class for handling APV files, especially the _spi_ file and _kill_ files

Definition

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

Constructors

ApvInitializes a new instance of the Apv class

Properties

SimRunning Set to true when simulation is running
ToConsole Set to true to get output to console

Methods

CancelSimulation Returns true if the simulation should be cancelled.
Custom Custom text to APV file.
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)
Finish Finish APV system
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)
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) Report the simulation progress in per-mille.
Obsolete
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
ToStringReturns a string that represents the current object.
(Inherited from Object)

See Also